DLI V222 Object Model Reference
Generated by Doxygen
20210317T201932Z
ii CONTENTS
Contents
1 DLI Controller API 2
2 Relay object 4
2.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.2 Online status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.3 Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.4 Relay version number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.5 Outlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.5.1 Outlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.6 Outlet: Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.7 Outlet: Configured state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.8 Outlet: Transient state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.9 Outlet: Physical state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.10 Outlet: Lock state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.11 Outlet: Critical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.12 Outlet: Outlet cycle delay, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.13 Outlet: Cycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
2.13.1 Action performed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.14 Outlet ON sequence delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.15 Minimal ON sequence delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.16 Default outlet cycle delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.17 Brown-out re-latch delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
2.18 Recovery mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.19 Buses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.19.1 Bus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
2.20 Bus: Outlet list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.20.1 Outlet index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
2.21 Bus: Voltage-affected outlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
2.21.1 Outlet list index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS iii
2.22 Bus: Minimum voltage, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
2.23 Bus: Maximum voltage, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
2.24 Bus: Current-affected outlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.24.1 Outlet list index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.25 Bus: Maximum current, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2.26 Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
2.26.1 I/O port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
2.27 I/O port: Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
2.28 I/O port: Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
2.29 I/O port: Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
2.29.1 Configuration value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
2.30 I/O port: Data reception mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
2.30.1 Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
2.31 I/O port: Send data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
2.31.1 Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
2.31.2 Empty result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.32 I/O port: Latest received data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.32.1 Data string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
2.33 Received data element: Reception time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
2.34 Received data element: Received data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
2.34.1 Data string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
2.35 I/O port: Get receive history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
2.35.1 Data start time, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
2.35.2 Data end time, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
2.35.3 Data history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
2.36 I/O port: Clear received data history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
2.36.1 Empty result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
2.37 Port types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
2.37.1 I/O port type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
2.38 I/O port type: Configuration structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
DLI V222 Object Model Reference: 20210317T201932Z
iv CONTENTS
2.38.1 Configuration item properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
2.39 I/O port type: Channel map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
2.39.1 Channel name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
2.40 Pins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
2.40.1 GPIO pin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
2.41 GPIO pin: Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
2.42 GPIO pin: Input bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
2.43 GPIO pin: Mode bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
2.44 GPIO pin: Level bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
2.45 GPIO pin: Mode driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
2.46 GPIO pin: Level driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
2.47 GPIO pin: Pin drive mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
2.47.1 Low mode, low level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
2.47.2 Low mode, high level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
2.47.3 High mode, low level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
2.47.4 High mode, high level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
2.48 GPIO pin: Latest input value, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
2.49 Net changes: Removed nets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
2.49.1 Removed net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
2.50 Net changes: Added nets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
2.50.1 Added net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
2.51 GPIO pin: Configure tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
2.51.1 Pin tracking configuration mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
2.51.2 Net changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
2.52 Net changes: Removed nets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
2.52.1 Removed net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
2.53 Net changes: Added nets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
2.53.1 Added net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
2.54 GPIO pin: Configure mode driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
2.54.1 Desired mode driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS v
2.54.2 Net changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
2.55 Net changes: Removed nets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
2.55.1 Removed net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
2.56 Net changes: Added nets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
2.56.1 Added net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
2.57 GPIO pin: Configure level driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
2.57.1 Desired level driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
2.57.2 Net changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
2.58 Nets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
2.59 Nets: GPIO net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
2.59.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
2.59.2 Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
2.59.3 Tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
2.59.4 Latest value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
2.60 Enable measurement-driven outlet control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
2.61 Minimum relay voltage, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
2.62 Measurement-driven relatch timeout, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
2.63 Keypad state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
2.64 LCD all-caps filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
2.65 Beep sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
2.66 Backlight sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
2.67 LCD column count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
2.68 LCD row count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
2.69 User LCD lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
2.69.1 User LCD line, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
2.70 User message force display timeout, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
2.71 User message display timeout, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
2.72 Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
2.72.1 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
2.73 Notifications: Parameter kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
2.73.1 Outlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
2.73.2 Configured state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
2.73.3 Transient state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
2.73.4 Physical state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
2.73.5 Lock state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
2.74 Event parameters: Event parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
2.74.1 Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
2.74.2 Fixed value flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
2.74.3 Fixed value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
2.75 Events: Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
2.75.1 Message template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
2.75.2 Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
2.75.3 Event parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
DLI V222 Object Model Reference: 20210317T201932Z
vi CONTENTS
3 Authentication server object 122
3.1 Users list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
3.1.1 User account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
3.2 User account: Username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
3.3 User account: Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
3.4 User account: User allowed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
3.5 User account: Administrative user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
3.6 User account: Outlet access levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
3.6.1 Outlet access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
3.7 Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
3.8 Cookie timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
3.9 Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
3.9.1 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
3.10 Notifications: Parameter kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
3.10.1 Username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
3.10.2 IP address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
3.10.3 Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
3.10.4 Reason . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
3.10.5 Authentication allowed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
3.10.6 User state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
3.11 Event parameters: Event parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
3.11.1 Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
3.11.2 Fixed value flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
3.11.3 Fixed value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
3.12 Events: Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
3.12.1 Message template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
3.12.2 Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
3.12.3 Event parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS vii
4 Configuration server object 146
4.1 Links list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
4.2 Links list: Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
4.2.1 URI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
4.2.2 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
4.3 Plots list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
4.3.1 Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
4.4 Plot: Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
4.5 Plot: Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
4.6 Plot: Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
4.7 Plot: Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
4.8 Plot: X1 axis settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
4.8.1 Minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
4.8.2 Maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
4.8.3 Soft minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
4.8.4 Soft maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
4.8.5 Major tick interval, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
4.8.6 Minor ticks per major tick, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
4.9 Plot: X2 axis settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
4.9.1 Minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
4.9.2 Maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
4.9.3 Soft minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
4.9.4 Soft maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
4.9.5 Major tick interval, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
4.9.6 Minor ticks per major tick, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
4.10 Plot: Y1 axis settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
4.10.1 Minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
4.10.2 Maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
4.10.3 Soft minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
4.10.4 Soft maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
DLI V222 Object Model Reference: 20210317T201932Z
viii CONTENTS
4.10.5 Major tick interval, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
4.10.6 Minor ticks per major tick, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
4.11 Plot: Y2 axis settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
4.11.1 Minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
4.11.2 Maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
4.11.3 Soft minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
4.11.4 Soft maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
4.11.5 Major tick interval, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
4.11.6 Minor ticks per major tick, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
4.12 Plot line configuration: Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
4.12.1 Line style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
4.12.2 Line type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
4.12.3 Line color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
4.12.4 Line width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
4.12.5 Marker type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
4.12.6 Marker size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
4.12.7 Base axes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
4.13 Plot: Plot lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
4.13.1 Plot line configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
4.14 Meters list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
4.14.1 Meter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
4.15 Meter configuration: Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
4.16 Meter configuration: Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
4.17 Meter configuration: Data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
4.18 Meter configuration: Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
4.19 Meter configuration: Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
4.20 Meter configuration: Display scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
4.21 Meter configuration: Decimals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
4.22 Meter configuration: Arrow color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
4.23 Meter configuration: Minimum value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS ix
4.24 Meter configuration: Meter sectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
4.24.1 Sector configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
4.25 Primary unit contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
4.26 Related contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
4.27 Related contacts: Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
4.27.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
4.27.2 Email, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
4.27.3 Phone number, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
4.27.4 Fax number, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
4.28 Unit location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
4.29 Model OID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
4.30 Version number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
4.31 Hardware ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
4.32 Serial number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
4.33 Outlet label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
4.34 Brand company name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
4.35 Brand name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
4.36 Brand URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
4.37 Brand manual URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
4.38 Brand FAQ URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
4.39 Brand product information URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
4.40 Support email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
4.41 Registration URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
4.42 Support URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
4.43 Update URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
4.44 Custom brand company name, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
4.45 Custom brand name, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
4.46 Custom brand URL, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
4.47 Custom brand logo URL, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
4.48 Custom brand logo width, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
DLI V222 Object Model Reference: 20210317T201932Z
x CONTENTS
4.49 Custom brand logo height, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
4.50 Custom support email, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
4.51 Custom registration URL, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
4.52 Custom support URL, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
4.53 Custom update URL, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
4.54 Custom help URL, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
4.55 Customization status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
4.56 Registration status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
4.57 Enable page refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
4.58 Page refresh delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
4.59 Preferred image format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
4.60 Unit hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
4.61 Time zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
4.62 HTTP ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
4.63 HTTP ports: Port binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
4.63.1 Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
4.63.2 Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
4.64 HTTPS ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
4.65 HTTPS ports: Port binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
4.65.1 Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
4.65.2 Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
4.66 HTTPS certificate settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
4.66.1 Bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
4.66.2 Distinguished name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
4.66.3 String mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
4.66.4 Domain names override, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
4.66.5 Addresses override, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
4.66.6 Automatic renewal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
4.66.7 Certificate renewal method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
4.66.8 HTTPS certificate signing request, if it can be generated . . . . . . . . . . . . . . . . . . 273
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS xi
4.66.9 HTTPS certificate chain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
4.66.10 HTTPS certificate key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
4.66.11 Renewal methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
4.67 Distinguished name: Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
4.67.1 Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
4.68 Domain names override, if any: Domain names override . . . . . . . . . . . . . . . . . . . . . . . 279
4.68.1 Hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
4.69 Addresses override, if any: Addresses override . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
4.69.1 IPv4 address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
4.70 HTTPS certificate settings: Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
4.70.1 Data item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
4.71 HTTPS certificate settings: Renew certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
4.71.1 Empty result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
4.72 HTTPS certificate settings: Generate key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
4.72.1 Empty result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
4.73 HTTPS certificate settings: Known DN OIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
4.73.1 OID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
4.74 Supported data items: Data item properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
4.74.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
4.74.2 Regular expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
4.74.3 Secret . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
4.75 Renewal methods: Renewal method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
4.75.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
4.75.2 Supported data items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
4.76 Certificate collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
4.77 Certificate collection: Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
4.77.1 Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
4.77.2 Trust status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
4.78 Certificate revocation list collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
4.79 Certificate revocation list collection: Certificate revocation list . . . . . . . . . . . . . . . . . . . . 301
DLI V222 Object Model Reference: 20210317T201932Z
xii CONTENTS
4.79.1 Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
4.79.2 Usage status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
4.80 SSH enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
4.81 SSH port number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
4.82 SSH authorized keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
4.83 SSH authorized keys: SSH authorized key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
4.83.1 Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
4.83.2 Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
4.83.3 Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
4.84 NTP server enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
4.85 NTP peers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
4.85.1 NTP peer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
4.86 Syslog threshold severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
4.87 Syslog server address, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
4.88 Allow JSON-RPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
4.89 Allow non-administrative users to perform JSON-RPC requests . . . . . . . . . . . . . . . . . . . 318
4.90 Allow REST-like API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
4.91 Allow non-administrative users to access REST-like API . . . . . . . . . . . . . . . . . . . . . . . 320
4.92 Allowed REST-like API client origins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
4.92.1 Allowed REST-like API client origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
4.93 Allow CoAP over WebSockets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
4.94 Allow non-administrative users to access CoAP over WebSockets . . . . . . . . . . . . . . . . . . 324
4.95 Allowed CoAP over WebSockets client origins . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
4.95.1 Allowed CoAP over WebSockets client origin . . . . . . . . . . . . . . . . . . . . . . . . . 326
4.96 Relax non-HTML method CSRF checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
4.97 Relax non-HTML content type CSRF checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
4.98 Allow plaintext logins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
4.99 Allow state-changing GET requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
4.100Relay name visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
4.101Hide user passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS xiii
4.102Hide WiFi key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
4.103Security lockout duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
4.104Protect firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
4.105Protect admin login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
4.106Protect network settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
4.107Protect private settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
4.108Protect from restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
4.109Protect from maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
4.110Protect notification settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
4.111Beep on upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
4.112Blink on upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
4.113Known quantities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
4.113.1 Quantity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
4.114Quantity: Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
4.115Quantity: Known units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
4.115.1 Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
4.116Quantity: Preferred unit, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
4.117Known timezones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
4.117.1 Timezone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
4.118Known protection bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
4.119Known protection bits: Protection bit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
4.119.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
4.119.2 Protection status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
4.120Relay ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
4.120.1 Relay port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
DLI V222 Object Model Reference: 20210317T201932Z
xiv CONTENTS
5 Network configuration data 360
5.1 Wired network data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
5.1.1 MAC address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
5.1.2 Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
5.1.3 IP address assignment protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
5.1.4 IP address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
5.1.5 Network mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
5.1.6 Default gateway IP address, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
5.1.7 Metric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
5.1.8 DNS server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
5.2 Wired network data: DNS servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
5.2.1 DNS server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
5.3 Wireless network data, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
5.3.1 Wireless network data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
5.4 Wireless network data: Enable wireless module . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
5.5 Wireless network data: Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
5.6 Wireless network data: MAC address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
5.7 Wireless network data: IP address assignment protocol . . . . . . . . . . . . . . . . . . . . . . . 378
5.8 Wireless network data: IP address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
5.9 Wireless network data: Network mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
5.10 Wireless network data: Default gateway IP address, if any . . . . . . . . . . . . . . . . . . . . . . 381
5.11 Wireless network data: Metric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
5.12 Wireless network data: DNS servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
5.12.1 DNS server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
5.13 Wireless network data: DNS server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
5.14 Wireless network data: Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
5.15 Wireless network data: Known modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
5.15.1 Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
5.16 Wireless network data: SSID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
5.17 Wireless network data: Wireless channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS xv
5.18 Wireless network data: Known channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
5.18.1 Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
5.19 Wireless network data: Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
5.20 Wireless network data: Known encryptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
5.20.1 Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
5.21 Wireless network data: Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
5.22 Access points: Access point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
5.22.1 Wireless channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
5.22.2 SSID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
5.22.3 Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
5.22.4 Signal level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
5.23 Wireless network data: Scan access points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
5.23.1 Access points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
5.24 Wireless network data: Wireless Accessory Configuration supported . . . . . . . . . . . . . . . . 400
5.25 Wireless network data: Wireless Accessory Configuration enabled . . . . . . . . . . . . . . . . . 401
5.26 Interface priority order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
5.26.1 Interface order element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
5.27 Same subnet restriction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
5.28 Known protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
5.28.1 Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
5.29 Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
5.29.1 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
5.30 Notifications: Parameter kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
5.30.1 Device name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
5.30.2 Device index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
5.30.3 Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
5.31 Event parameters: Event parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
5.31.1 Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
5.31.2 Fixed value flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
5.31.3 Fixed value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
5.32 Events: Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
5.32.1 Message template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
5.32.2 Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
5.32.3 Event parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
DLI V222 Object Model Reference: 20210317T201932Z
xvi CONTENTS
6 Event notification server object 419
6.1 Sinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
6.1.1 Sink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
6.2 Sink: Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
6.3 Sink: Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
6.4 Sink: Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
6.4.1 Data item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
6.5 Sink: Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
6.5.1 Notification status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
6.6 Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
6.7 Rules: Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
6.7.1 Rule condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
6.7.2 Rule action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
6.8 Sink types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
6.8.1 Sink type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
6.9 Sink type: Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
6.10 Sink type: Supported data items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
6.10.1 Data item properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
6.11 Sink data item groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
6.12 Sink data item groups: Sink data item group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
6.12.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
6.12.2 Secret . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
6.12.3 Immutable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
6.12.4 Unreadable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS xvii
7 Autoping server object 445
7.1 Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
7.2 Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
7.2.1 Autoping item data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
7.3 Autoping item data: Enabled status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
7.4 Autoping item data: Address list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
7.4.1 Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
7.5 Autoping item data: Controlled outlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
7.5.1 Outlet index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
7.6 Autoping item data: Script command, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
7.7 Autoping item data: Request item state change . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
7.7.1 Desired item state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
7.7.2 Empty result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
7.8 Target states: Target state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
7.8.1 Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
7.8.2 State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
7.8.3 State details, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
7.8.4 Success count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
7.8.5 Failure count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
7.8.6 Queue size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
7.9 Autoping item data: Autoping item status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
7.9.1 Target states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
7.9.2 Reboot count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
7.10 Autoping item data: Pings remaining to enable, if any . . . . . . . . . . . . . . . . . . . . . . . . 466
7.11 Autoping item data: Recently failed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
7.12 Autoping item data: In resumption trial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
7.13 Ping interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
7.14 Ping timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
7.15 Post-reboot delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
7.16 Default maximum total reboot count, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
DLI V222 Object Model Reference: 20210317T201932Z
xviii CONTENTS
7.17 Default maximum consecutive reboot count, if any . . . . . . . . . . . . . . . . . . . . . . . . . . 473
7.18 Pings before enabling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
7.19 Resume without retrial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
7.20 Handle failures immediately . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
7.21 Reset statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
7.21.1 Empty result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
7.22 Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
7.22.1 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
7.23 Notifications: Parameter kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
7.23.1 Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
7.23.2 Ping state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
7.23.3 Ping time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
7.23.4 Ping timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
7.23.5 Item state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
7.23.6 Item name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
7.23.7 Item script name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
7.23.8 Item addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
7.23.9 Total failure count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
7.23.10 Consecutive failure count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
7.23.11 Maximum total failure count, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
7.23.12 Maximum consecutive failure count, if any . . . . . . . . . . . . . . . . . . . . . . . . . . 484
7.23.13 Pings before enabling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
7.24 Event parameters: Event parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
7.24.1 Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
7.24.2 Fixed value flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
7.24.3 Fixed value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
7.25 Events: Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
7.25.1 Message template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
7.25.2 Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
7.25.3 Event parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS xix
8 Scripting server object 494
8.1 User script source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
8.2 Script snippets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
8.3 Script snippets: Script snippet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
8.3.1 Snippet source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
8.4 User functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
8.4.1 User script function signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
8.5 User function UI order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
8.5.1 User script function name for index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
8.6 Script to start at startup, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
8.7 Legacy startup handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
8.8 Thread map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
8.9 Thread map: Scripting thread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
8.9.1 Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
8.10 Start a script thread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
8.10.1 Resulting thread ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
8.11 Start a script thread: Code source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
8.11.1 User function, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
8.11.2 User code, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
8.11.3 Displayed source code, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
8.12 Stop a script thread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
8.12.1 Thread(s) to stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
8.12.2 Empty result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
8.13 Script external variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
8.13.1 Script external variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
8.14 Script tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
8.15 Script step delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
8.16 Script step time limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
8.17 Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
8.17.1 Parameter kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
DLI V222 Object Model Reference: 20210317T201932Z
xx CONTENTS
8.17.2 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
8.18 Parameter kinds: Script message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
8.19 Parameter kinds: Script data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
8.19.1 Script data element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
8.20 Parameter kinds: Thread ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
8.21 Parameter kinds: Thread name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
8.22 Parameter kinds: Thread origin, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
8.23 Parameter kinds: Thread start reason, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
8.24 Parameter kinds: Thread stop reason . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
8.25 Parameter kinds: Thread state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
8.26 Parameter kinds: Thread error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
8.27 Event parameters: Event parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
8.27.1 Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
8.27.2 Fixed value flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
8.27.3 Fixed value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
8.28 Events: Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
8.28.1 Message template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
8.28.2 Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
8.28.3 Event parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
9 SNMP server object 532
9.1 Allow SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
9.2 Engine ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
9.3 OID subtrees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
9.4 OID subtrees: OID subtree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
9.4.1 Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
9.4.2 Root mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
9.4.3 Read security level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
9.4.4 Write security level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
9.5 Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
9.5.1 User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS xxi
9.6 User: User allowed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
9.7 User: Authentication method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
9.8 User: Authentication password configured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
9.9 User: Authentication password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
9.10 User: Privacy method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
9.11 User: Privacy password configured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
9.12 User: Privacy password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
9.13 User: Subtree access levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
9.13.1 Subtree access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
9.14 Community mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
9.15 Community mappings: Community mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
9.15.1 Community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
9.15.2 User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
9.15.3 IP address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
9.15.4 Network mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
9.16 Known authentication methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
9.16.1 Authentication method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
9.17 Known privacy methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
9.17.1 Privacy method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
10 UPnP server object 564
10.1 Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
10.2 Outlet UPnP configuration settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
10.3 Outlet UPnP configuration settings: Outlet UPnP configuration . . . . . . . . . . . . . . . . . . . . 567
10.3.1 Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
10.3.2 Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
10.3.3 Exposed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
10.3.4 Alternate name, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
10.4 UPnP device profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
10.4.1 UPnP device profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
10.5 UPnP device profile: Namespace identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
DLI V222 Object Model Reference: 20210317T201932Z
xxii CONTENTS
10.6 UPnP device profile: Device namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
10.7 UPnP device profile: Manufacturer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
10.8 UPnP device profile: Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
10.9 UPnP device profile: Model number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
10.10UPnP device profile: UUID prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
10.11UPnP device profile: Device type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
10.12UPnP device profile: Device version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
10.13UPnP device profile: Service namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
10.14UPnP device profile: Service ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
10.15UPnP device profile: Service type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
10.16UPnP device profile: Service version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
10.17UPnP device profile: Service control URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
10.18UPnP device profile: Service event subscription URL . . . . . . . . . . . . . . . . . . . . . . . . 588
10.19UPnP device profile: Service SCPD URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
10.20UPnP device profile: Variable types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
10.20.1 Variable type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
10.21UPnP device profile: State variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
10.21.1 State variable binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
10.22Arguments: Argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
10.22.1 Argument name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
10.22.2 Argument type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
10.22.3 Output/return value flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
10.22.4 Related state variable identifier, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
10.23UPnP device profile: Action map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
10.23.1 Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
10.24UPnP device profile: SOAP XML namespace prefix override, if any . . . . . . . . . . . . . . . . . 609
10.25UPnP device profile: Service XML namespace prefix override, if any . . . . . . . . . . . . . . . . 610
10.26UPnP device profile: Event XML namespace prefix override, if any . . . . . . . . . . . . . . . . . 611
10.27Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
10.27.1 Parameter kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
10.27.2 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
10.28Event parameters: Event parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
10.28.1 Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
10.28.2 Fixed value flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
10.28.3 Fixed value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
10.29Events: Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
10.29.1 Message template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
10.29.2 Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
10.29.3 Event parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS xxiii
11 MQTT client object 623
11.1 Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
11.2 Outlet MQTT configuration settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
11.3 Outlet MQTT configuration settings: Outlet MQTT configuration . . . . . . . . . . . . . . . . . . . 627
11.3.1 Topic subtree, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
11.3.2 Allow read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
11.3.3 Allow write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
11.3.4 State subscription and report QoS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
11.4 MQTT broker address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
11.5 MQTT broker port, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
11.6 Use SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
11.7 Username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
11.8 Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
11.9 Topic root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
11.10Connection message topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
11.11Connection message payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
11.12Connection message QoS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
11.13Connection message retain flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
11.14Reconnection message topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
11.15Reconnection message payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
11.16Reconnection message QoS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
11.17Reconnection message retain flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
11.18Disconnection message topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
11.19Disconnection message payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
11.20Disconnection message QoS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
11.21Disconnection message retain flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
11.22Last Will and Testament topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
11.23Last Will and Testament payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
11.24Last Will and Testament QoS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
11.25Last Will and Testament retain flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
11.26Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
11.26.1 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
11.27Notifications: Parameter kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.27.1 Connection status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.28Event parameters: Event parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.28.1 Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
11.28.2 Fixed value flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
11.28.3 Fixed value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
11.29Events: Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
11.29.1 Message template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
11.29.2 Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
11.29.3 Event parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
DLI V222 Object Model Reference: 20210317T201932Z
xxiv CONTENTS
12 Meter server object 665
12.1 Measured values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
12.1.1 Measured value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
12.2 Measured value: Value name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
12.3 Measured value: Value, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
12.4 Measured value: Expression, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
12.5 Measured value: Custom flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
12.6 Measured value: Calibration flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
12.7 Measured value: Calibration support flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
12.8 Measured value: Insert calibration point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
12.8.1 Kind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
12.8.2 Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
12.8.3 Weight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
12.8.4 Derivative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
12.8.5 Derivative weight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
12.8.6 Empty result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
12.9 Measured value: Commit calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
12.9.1 Empty result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
12.10Measured value: Quantity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
12.11Measured value: Bus index, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
12.12Measured value: Internal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
12.13Measured value: Log history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
12.14Measured value: History log parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
12.14.1 History log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
12.15Measured value: History subsample count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
12.16Measured value: History time step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
12.17Value history record: Value history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
12.17.1 Data point, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
12.18Measured value: Get value history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
12.18.1 Data start time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS xxv
12.18.2 Data end time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
12.18.3 Data time step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
12.18.4 Value history record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
12.19Measured value: Clear value history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
12.19.1 Empty result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
12.20Measured value: Data absence alarm level, if any . . . . . . . . . . . . . . . . . . . . . . . . . . 695
12.21Measured value: Data absence alarm period, if any . . . . . . . . . . . . . . . . . . . . . . . . . 696
12.22Measured value: Lowest interval alarm level, if any . . . . . . . . . . . . . . . . . . . . . . . . . . 697
12.23Measured value: Lowest interval alarm period, if any . . . . . . . . . . . . . . . . . . . . . . . . . 698
12.24Measured value: Value interval properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
12.24.1 Interval configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
12.25Bus list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
12.26Bus list: Bus attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
12.26.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
12.26.2 Power status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
12.26.3 Power factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
12.27Power status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
12.28Emergency shutoff status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
12.29Synchronize meter data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
12.29.1 Empty result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
12.30Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
12.30.1 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
12.31Notifications: Parameter kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
12.31.1 Bus index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
12.31.2 Bus name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
12.31.3 Bus power status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
12.31.4 Power status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
12.31.5 Emergency shutoff status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
12.31.6 Value identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
12.31.7 Value name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
12.31.8 Value alarm level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
12.31.9 Value alarm repeat count, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
12.31.10Value alarm duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
12.32Event parameters: Event parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
12.32.1 Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
12.32.2 Fixed value flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
12.32.3 Fixed value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
12.33Events: Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
12.33.1 Message template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
12.33.2 Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
12.33.3 Event parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
DLI V222 Object Model Reference: 20210317T201932Z
xxvi CONTENTS
13 Renderer object 725
13.1 Draw a plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
13.1.1 Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
13.1.2 Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
13.1.3 Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
13.1.4 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
13.1.5 Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
13.1.6 Content type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
13.1.7 Image data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
13.2 Properties: Custom time format, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
13.3 Properties: X1 axis settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
13.3.1 Minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
13.3.2 Maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
13.3.3 Soft minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
13.3.4 Soft maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
13.3.5 Major tick interval, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
13.3.6 Minor ticks per major tick, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
13.4 Properties: X2 axis settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
13.4.1 Minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
13.4.2 Maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
13.4.3 Soft minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
13.4.4 Soft maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
13.4.5 Major tick interval, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
13.4.6 Minor ticks per major tick, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
13.5 Properties: Y1 axis settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
13.5.1 Minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
13.5.2 Maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
13.5.3 Soft minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
13.5.4 Soft maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
13.5.5 Major tick interval, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS xxvii
13.5.6 Minor ticks per major tick, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
13.6 Properties: Y2 axis settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
13.6.1 Minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
13.6.2 Maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
13.6.3 Soft minimum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
13.6.4 Soft maximum, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
13.6.5 Major tick interval, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
13.6.6 Minor ticks per major tick, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
13.7 Plot data: Plot point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
13.7.1 X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
13.7.2 Y, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
13.8 Plotted quantities and units: X axis quantity and unit . . . . . . . . . . . . . . . . . . . . . . . . . 748
13.8.1 X axis quantity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
13.8.2 X axis unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
13.9 Plotted quantities and units: Y axis quantity and unit . . . . . . . . . . . . . . . . . . . . . . . . . 750
13.9.1 Y axis quantity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
13.9.2 Y axis unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
13.10Lines: Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
13.10.1 Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
13.10.2 Plot data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
13.10.3 Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
13.10.4 Plotted quantities and units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
13.11Draw a pie meter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
13.11.1 Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
13.11.2 Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
13.11.3 Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
13.11.4 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
13.11.5 Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
13.11.6 Content type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
13.11.7 Image data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
DLI V222 Object Model Reference: 20210317T201932Z
CONTENTS 1
13.12Properties: Arrow color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
13.13Properties: Display scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
13.14Properties: Decimals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
13.15Properties: Minimum value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
13.16Properties: Meter sectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
13.16.1 Sector parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
13.17Draw a pie meter: Value quantity and unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
13.17.1 Value quantity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
13.17.2 Value unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
13.18Draw a message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
13.18.1 Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
13.18.2 Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
13.18.3 Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
13.18.4 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
13.18.5 Content type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
13.18.6 Image data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
13.19Plot styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
13.19.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
13.20Plot scales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
13.20.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
13.21Line types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
13.21.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
13.22Marker types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
13.22.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
13.23Axes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
13.23.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781
13.24Image formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
13.24.1 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
DLI V222 Object Model Reference: 20210317T201932Z
2 CONTENTS
14 Credentials 784
14.1 Client username, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
14.2 Administrative user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
14.3 Outlet access permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
14.4 Outlet access permissions: Outlet access levels . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
14.4.1 Outlet access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
14.5 Agent identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
14.6 Client IP address, if any . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
1 DLI Controller API
object
The set of objects that comprise the controller's API
Relay objectname:Nameonline:Online statusmodel:Modelversion:Relay version numberoutlets:Outletssequence_delay:Outlet ON sequence delaymin_sequence_delay:Minimal ON sequence delaycycle_delay:Default outlet cycle delayrelatch:Brown-out re-latch delayrecovery_mode:Recovery modebuses:Busesports:Portsknown_port_types:Port typespins:Pinsnets:Netsfuses_enabled:Enable measurement-driven outlet controlmin_relay_voltage:Minimum relay voltage, if anyfuse_relatch:Measurement-driven relatch timeout, if anykeypad_enabled:Keypad stateall_caps:LCD all-caps filterbeep_sequence:Beep sequencebacklight_sequence:Backlight sequencelcd_columns:LCD column countlcd_rows:LCD row countuser_lines:User LCD linesuser_message_force_timeout:User message force display timeout, if anyuser_message_timeout:User message display timeout, if anynotifications:Notifications
Authentication server objectusers:Users listrealm:Realmcookie_timeout:Cookie timeoutnotifications:Notifications
Administrative userAdministratorRegular user
can_read
Configuration server objectlinks:Links listplots:Plots listmeters:Meters listcontact:Primary unit contactcontacts:Related contactslocation:Unit locationoid:Model OIDversion:Version numberhardware_id:Hardware IDserial:Serial numberoutlet_label:Outlet labelbrand_company_name:Brand company namebrand_name:Brand namebrand_url:Brand URLbrand_manual_url:Brand manual URLbrand_faq_url:Brand FAQ URLbrand_product_info_url:Brand product information URLsupport_email:Support emailregister_url:Registration URLsupport_url:Support URLupdate_url:Update URLcustom_brand_company_name:Custom brand company name, if anycustom_brand_name:Custom brand name, if anycustom_brand_url:Custom brand URL, if anycustom_brand_logo:Custom brand logo URL, if anycustom_brand_logo_width:Custom brand logo width, if anycustom_brand_logo_height:Custom brand logo height, if anycustom_support_email:Custom support email, if anycustom_register_url:Custom registration URL, if anycustom_support_url:Custom support URL, if anycustom_update_url:Custom update URL, if anycustom_help_url:Custom help URL, if anycustomization_status:Customization statusregistration_status:Registration statusrefresh_enabled:Enable page refreshrefresh_delay_minutes:Page refresh delayimage_format:Preferred image formathostname:Unit hostnametimezone:Time zonehttp_ports:HTTP portshttps_ports:HTTPS portshttps_cert:HTTPS certificate settingscertificates:Certificate collectioncrls:Certificate revocation list collectionssh_enabled:SSH enabledssh_port:SSH port numberssh_authorized_keys:SSH authorized keysntp_server_enabled:NTP server enabledntp_peers:NTP peerssyslog_minimal_severity:Syslog threshold severitysyslog_ip_address:Syslog server address, if anyallow_jsonrpc:Allow JSON-RPCallow_jsonrpc_nonadmin:Allow non-administrative users to perform JSON-RPC requestsallow_restapi:Allow REST-like APIallow_restapi_nonadmin:Allow non-administrative users to access REST-like APIallow_restapi_origins:Allowed REST-like API client originsallow_coapws:Allow CoAP over WebSocketsallow_coapws_nonadmin:Allow non-administrative users to access CoAP over WebSocketsallow_coapws_origins:Allowed CoAP over WebSockets client originsrelax_nonhtml_methods:Relax non-HTML method CSRF checksrelax_nonhtml_content_types:Relax non-HTML content type CSRF checksallow_plaintext_logins:Allow plaintext loginsallow_modifying_get:Allow state-changing GET requestsname_always_visible:Relay name visibilityhide_passwords:Hide user passwordshide_wifi_key:Hide WiFi keylockout_delay_minutes:Security lockout durationprotect_firmware:Protect firmwareprotect_admin:Protect admin loginprotect_network:Protect network settingsprotect_private_config:Protect private settingsprotect_restore:Protect from restoreprotect_maintenance:Protect from maintenanceprotect_notification:Protect notification settingsupgrade_notify_beep:Beep on upgradeupgrade_notify_blink:Blink on upgradeknown_quantities:Known quantitiesknown_timezones:Known timezonesknown_protection_bits:Known protection bitsrelay_ports:Relay ports
Network configuration datawired:Wired network datawireless:Wireless network data, if anyinterface_order:Interface priority ordersame_subnet_only:Same subnet restrictionknown_protocols:Known protocolsnotifications:Notifications
can_readEvent notification server object
sinks:Sinksrules:Rulesknown_sink_types:Sink typessink_data_item_groups:Sink data item groups
can_readAutoping server object
enabled:Enableditems:Itemsping_interval:Ping intervalping_timeout:Ping timeoutpost_reboot_delay:Post-reboot delaymax_reboot_count:Default maximum total reboot count, if anymax_consecutive_reboot_count:Default maximum consecutive reboot count, if anypings_before_enabling:Pings before enablingresume_without_retrial:Resume without retrialhandle_failures_immediately:Handle failures immediatelyreset_statistics:Reset statisticsnotifications:Notifications
can_read
Scripting server objectsource:User script sourcesnippets:Script snippetsuser_functions:User functionsuser_function_ui_order:User function UI orderboot_handler:Script to start at startup, if anyboot_handler_legacy:Legacy startup handlingthreads:Thread mapstart:Start a script threadstop:Stop a script threadvariables:Script external variablestraced:Script tracingstep_delay:Script step delaystep_time_limit:Script step time limitnotifications:Notifications
can_read
SNMP server objectenabled:Allow SNMPengine_id:Engine IDoid_subtrees:OID subtreesusers:Userscommunity_mappings:Community mappingsknown_auth_methods:Known authentication methodsknown_priv_methods:Known privacy methods
can_read
UPnP server objectenabled:Enabledoutlets:Outlet UPnP configuration settingsprofiles:UPnP device profilesnotifications:Notifications
can_read
MQTT client objectenabled:Enabledoutlets:Outlet MQTT configuration settingsbroker_address:MQTT broker addressbroker_port:MQTT broker port, if anyuse_ssl:Use SSLusername:Usernamepassword:Passwordtopic_root:Topic rootconnect_topic:Connection message topicconnect_payload:Connection message payloadconnect_qos:Connection message QoSconnect_retain:Connection message retain flagreconnect_topic:Reconnection message topicreconnect_payload:Reconnection message payloadreconnect_qos:Reconnection message QoSreconnect_retain:Reconnection message retain flagdisconnect_topic:Disconnection message topicdisconnect_payload:Disconnection message payloaddisconnect_qos:Disconnection message QoSdisconnect_retain:Disconnection message retain flaglwt_topic:Last Will and Testament topiclwt_payload:Last Will and Testament payloadlwt_qos:Last Will and Testament QoSlwt_retain:Last Will and Testament retain flagnotifications:Notifications
can_read
Meter server objectvalues:Measured valuesbuses:Bus listpower_status:Power statusemergency_off_status:Emergency shutoff statussynchronize:Synchronize meter datanotifications:Notifications
Renderer objectdraw_plot:Draw a plotdraw_pie_meter:Draw a pie meterdraw_message:Draw a messageknown_plot_styles:Plot stylesknown_scales:Plot scalesknown_line_types:Line typesknown_marker_types:Marker typesknown_axes:Axesknown_image_formats:Image formats
can_read
Credentialsname:Client username, if anyis_admin:Administrative useroutlet_access:Outlet access permissionsagent:Agent identifierip_address:Client IP address, if any
DLI Controller APIrelay:Relay objectauth:Authentication server objectconfig:Configuration server objectnetwork:Network configuration datanotification:Event notification server objectautoping:Autoping server objectscript:Scripting server objectsnmp:SNMP server objectupnp:UPnP server objectmqtt:MQTT client objectmeter:Meter server objectrenderer:Renderer objectcred:Credentials
This is an automatically generated document describing the object model and containing samples interacting withit.
DLI V222 Object Model Reference: 20210317T201932Z
1 DLI Controller API 3
It is advised that you use the latest curl version to interact with the object model. In particular, some versions areknown not to implement digest authentication correctly.Sample curl request path URI template arguments are stringkeys or 0-based integer indices of the entities involved. Template arguments need URL-encoding. Matrix URIs aresupported.
The uom command-line utility is available in firmware versions 1.8.1.0 and above.Its sample request path shellvariables are string keys or 0-based integer indices of the entities involved. Strings might need URL-encoding ifthey contain a slash ('/') or a percent sign ('').
The Python requests module samples assume the following preamble:
from __future__ import print_functionimport requestsfrom requests.auth import HTTPDigestAuthheaders = {'accept': 'application/json','content-type': 'application/json',' ←↩
↪→ prefer': 'return=minimal','x-csrf': 'x'}auth = HTTPDigestAuth('admin', '1234')
Python requests sample request path variables are string keys or 0-based integer indices of the entities involved.Template arguments need URL-encoding. Matrix URIs are supported.
The JavaScript request module samples assume that you require https://github.com/request/requestor an API-compatible alternative like https://github.com/postmanlabs/postman-request and usethe following preamble:
var request=require("request").defaults({baseUrl: "http://192.168.0.100/restapi ←↩↪→ /", auth: {user: "admin", pass: "1234", sendImmediately: false}, json: true ←↩↪→ , headers: {"X-CSRF": "x", "Prefer": "return=minimal" }});
Alternately you can supply the defaults enumerated on each request.JavaScript request sample path variables arestring keys or 0-based integer indices of the entities involved. Template arguments need URL-encoding. MatrixURIs are supported.
The Lua uom module is available in firmware versions 1.8.1.0 and above.Lua uom module samples assume thefollowing preamble:
local uom=require("uom")local null=uom.null
Lua uom module sample request path variables are string keys or 1-based integer indices of the entities involved.
This object contains the following items:
relay Relay object
auth Authentication server object
config Configuration server object
network Network configuration data
notification Event notification server object
autoping Autoping server object
script Scripting server object
snmp SNMP server object
upnp UPnP server object
mqtt MQTT client object
meter Meter server object
renderer Renderer object
cred Credentials
DLI V222 Object Model Reference: 20210317T201932Z
4 CONTENTS
Sample JS request read command:
request.get({url:""},function(error,response,body) {console.log(body)});
⇒<...>
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/"
⇒...
Browse more samples
2 Relay object
object relay/
Object representing relay state and configuration
Outlets[element]:Outlet
check
Buses[element]:Bus
check
Ports[element]:I/O port
Administrative userAdministratorRegular user
can_read,can_write
Agent identifier
readonly
Port types[element]:I/O port type
can_read,can_write
readonly
check
Pins[element]:GPIO pin
can_read,can_write
readonly
Nets[element]:GPIO net
can_read,can_writecheck
User LCD lines[element]:User LCD line, if any
can_read,can_write
descref__relay__lcd_rowscheck
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
Relay objectname:Nameonline:Online statusmodel:Modelversion:Relay version numberoutlets:Outletssequence_delay:Outlet ON sequence delaymin_sequence_delay:Minimal ON sequence delaycycle_delay:Default outlet cycle delayrelatch:Brown-out re-latch delayrecovery_mode:Recovery modebuses:Busesports:Portsknown_port_types:Port typespins:Pinsnets:Netsfuses_enabled:Enable measurement-driven outlet controlmin_relay_voltage:Minimum relay voltage, if anyfuse_relatch:Measurement-driven relatch timeout, if anykeypad_enabled:Keypad stateall_caps:LCD all-caps filterbeep_sequence:Beep sequencebacklight_sequence:Backlight sequencelcd_columns:LCD column countlcd_rows:LCD row countuser_lines:User LCD linesuser_message_force_timeout:User message force display timeout, if anyuser_message_timeout:User message display timeout, if anynotifications:Notifications
This object contains the following items:
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 5
name Nameonline Online statusmodel Modelversion Relay version number
outlets Outletssequence_delay Outlet ON sequence delay
min_sequence_delay Minimal ON sequence delay
cycle_delay Default outlet cycle delay
relatch Brown-out re-latch delay
recovery_mode Recovery mode
buses Busesports Ports
known_port_types Port types
pins Pins
nets Netsfuses_enabled Enable measurement-driven outlet controlmin_relay_voltage Minimum relay voltage, if any
fuse_relatch Measurement-driven relatch timeout, if any
keypad_enabled Keypad state
all_caps LCD all-caps filter
beep_sequence Beep sequence
backlight_sequence Backlight sequence
lcd_columns LCD column countlcd_rows LCD row countuser_lines User LCD linesuser_message_force_timeout User message force display timeout, if any
user_message_timeout User message display timeout, if any
notifications Notifications
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/"
⇒...
Sample uom library write command:
uom.relay=<...>
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
6 CONTENTS
2.1 Name
string relay/name/
User-visible relay name
Name Administrative userAdministratorRegular user
can_write
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample JS request write command:
request.put({url:"relay/name/",body:"My controller"});
Sample uom library read command:
print(uom.dump(uom.relay.name))
⇒"My controller"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 7
2.2 Online status
sum (variant) relay/online/
Relay module online status
Online statusOnlineDegradedOffline
Administrative userAdministratorRegular user
can_read
Agent identifier
readonly
Retrieving the value is denied if not administrative user
This sum does not support direct modification if agent identifier is not equal to relay.
This sum can assume the following values:
constant true Online The relay module is online and fully operational, out-lets can be switched on unless emergency shutoff isactivated
constant "degraded" Degraded The relay module is online but outlets cannot beswitched on due to low-power conditions
constant false Offline The relay module is offline, outlets cannot be switchedon
Sample CLI read command:
uom get "relay/online"
⇒true
Sample uom library read command:
print(uom.dump(uom.relay.online))
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
8 CONTENTS
2.3 Model
string relay/model/
Relay model name
Model Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/model/"
⇒"EPCR5"
Sample JS request read command:
request.get({url:"relay/model/"},function(error,response,body) {console.log(body) ←↩↪→ });
⇒"EPCR5"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 9
2.4 Relay version number
string relay/version/
Relay core firmware version number
Relay version number
Administrative userAdministratorRegular user
can_read
Agent identifier
readonly
Retrieving the value is denied if not administrative user
This string does not support direct modification if agent identifier is not equal to relay.
Sample CLI read command:
uom get "relay/version"
⇒"1.8.1.0"
Sample CLI write command:
uom set "relay/version" "\"1.8.1.0\""
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 CONTENTS
2.5 Outlets
array relay/outlets/
Outlets controlled by the relay
Outletname:Namestate:Configured statetransient_state:Transient statephysical_state:Physical statelocked:Lock statecritical:Criticalcycle_delay:Outlet cycle delay, if anycycle:Cycle
can_read:index,can_invoke:index,can_write:indexOutlets
[element]:Outlet 0..*
check
This array does not support direct modification.
This array represents a value in persistent storage.
This array contains Outlet elements.
Creating elements in this collection is not supported.
Sample CLI read command:
uom get "relay/outlets"
⇒...
Sample JS request read command:
request.get({url:"relay/outlets/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒<...>
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 11
2.5.1 Outlet
object relay/outlets/N/
Object representing outlet state and configuration
This object contains the following items:
name Namestate Configured state
transient_state Transient statephysical_state Physical state
locked Lock statecritical Criticalcycle_delay Outlet cycle delay, if any
cycle Cycle
Sample JS request read command (note that _outlet_index is a variable):
request.get({url:"relay/outlets/"+_outlet_index.toString()+"/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒{"state":false,"critical":true,"cycle_delay":5,"locked":false,"transient_state": ←↩
↪→ true,"physical_state":true,"name":"Local alarm lights"}
Sample uom library write command (note that _outlet_index is a variable):
uom.relay.outlets[_outlet_index]={critical=true,cycle_delay=7,locked=true,name=" ←↩↪→ Cooling fans",physical_state=true,state=false,transient_state=true}
Browse more samples
See also Outlet: Name
See also Outlet: Configured state
See also Outlet: Transient state
See also Outlet: Physical state
See also Outlet: Lock state
See also Outlet: Critical
See also Outlet: Outlet cycle delay, if any
See also Outlet: Cycle
DLI V222 Object Model Reference: 20210317T201932Z
12 CONTENTS
2.6 Outlet: Name
string relay/outlets/N/name/
User-visible outlet name
Name
Administrative userAdministratorRegular user
can_write
Outlet access permissionsFullNoneOutlet access levels
can_read
Outletname:Namestate:Configured statetransient_state:Transient statephysical_state:Physical statelocked:Lock statecritical:Criticalcycle_delay:Outlet cycle delay, if anycycle:Cycle
can_read:index
Retrieving the value is denied if any of the following is true:
• outlet access permissions is equal to false
• all of the following is true:
– outlet access permissions is not equal to true
– not outlet access permissions[index of outlet]
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample curl read command (note that :outlet_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/outlets/:outlet_index/name/"
⇒
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 13
"Power grid"
Sample requests read command (note that _outlet_index is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/outlets/'+str( ←↩↪→ _outlet_index)+'/name/',auth=auth,headers=headers).json())
⇒'Server'
Browse more samples
2.7 Outlet: Configured state
sum (boolean) relay/outlets/N/state/
Saved configured state of the outlet. Cannot be changed if the outlet is locked
Configured stateOnOff
Outletname:Namestate:Configured statetransient_state:Transient statephysical_state:Physical statelocked:Lock statecritical:Criticalcycle_delay:Outlet cycle delay, if anycycle:Cycle
can_read:index,can_write:index
Outlet access permissionsFullNoneOutlet access levels
can_read,can_write
Lock stateLockedUnlocked
can_write
Retrieving the value is denied if any of the following is true:
• outlet access permissions is equal to false
• all of the following is true:
– outlet access permissions is not equal to true
DLI V222 Object Model Reference: 20210317T201932Z
14 CONTENTS
– not outlet access permissions[index of outlet]
Changing the value is denied if any of the following is true:
• any of the following is true:
– outlet access permissions is equal to false
– all of the following is true:
* outlet access permissions is not equal to true
* not outlet access permissions[index of outlet]
• lock state
This sum represents a value in persistent storage.
Changes to this sum may have an effect besides setting value.
This sum can assume the following values:
constant true On The outlet is powered
constant false Off The outlet is not powered
Sample JS request write command (note that _outlet_index is a variable):
request.put({url:"relay/outlets/"+_outlet_index.toString()+"/state/",body:true});
Sample requests read command (note that _outlet_index is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/outlets/'+str( ←↩↪→ _outlet_index)+'/state/',auth=auth,headers=headers).json())
⇒False
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 15
2.8 Outlet: Transient state
sum (boolean) relay/outlets/N/transient_state/
Current expected state of the outlet. Cannot be changed if the outlet is locked
Transient stateOnOff
Outletname:Namestate:Configured statetransient_state:Transient statephysical_state:Physical statelocked:Lock statecritical:Criticalcycle_delay:Outlet cycle delay, if anycycle:Cycle
can_read:index,can_write:index
Outlet access permissionsFullNoneOutlet access levels
can_read,can_write
Lock stateLockedUnlocked
can_write
Retrieving the value is denied if any of the following is true:
• outlet access permissions is equal to false
• all of the following is true:
– outlet access permissions is not equal to true
– not outlet access permissions[index of outlet]
Changing the value is denied if any of the following is true:
• any of the following is true:
– outlet access permissions is equal to false
– all of the following is true:
* outlet access permissions is not equal to true
* not outlet access permissions[index of outlet]
• lock state
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
16 CONTENTS
constant true On The outlet is powered
constant false Off The outlet is not powered
Sample CLI read command (note that outlet_index is a variable):
uom get "relay/outlets/${outlet_index}/transient_state"
⇒false
Sample curl read command (note that :outlet_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/outlets/:outlet_index/transient_state/"
⇒false
Browse more samples
2.9 Outlet: Physical state
sum (boolean) relay/outlets/N/physical_state/
Current actual state of the outlet
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 17
Physical stateOnOff
Outletname:Namestate:Configured statetransient_state:Transient statephysical_state:Physical statelocked:Lock statecritical:Criticalcycle_delay:Outlet cycle delay, if anycycle:Cycle
can_read:index
Outlet access permissionsFullNoneOutlet access levels
can_read
Agent identifier
readonly,can_write
Retrieving the value is denied if any of the following is true:
• outlet access permissions is equal to false
• all of the following is true:
– outlet access permissions is not equal to true
– not outlet access permissions[index of outlet]
Changing the value is denied if agent identifier is not equal to relay
This sum does not support direct modification if agent identifier is not equal to relay.
This sum can assume the following values:
constant true On The outlet is powered
constant false Off The outlet is not powered
Sample requests read command (note that _outlet_index is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/outlets/'+str( ←↩↪→ _outlet_index)+'/physical_state/',auth=auth,headers=headers).json())
⇒False
DLI V222 Object Model Reference: 20210317T201932Z
18 CONTENTS
Sample curl read command (note that :outlet_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/outlets/:outlet_index/physical_state/"
⇒true
Browse more samples
2.10 Outlet: Lock state
sum (boolean) relay/outlets/N/locked/
Indicates whether the outlet state is locked from keypad
Lock stateLockedUnlocked
can_write,can_invoke
Outletname:Namestate:Configured statetransient_state:Transient statephysical_state:Physical statelocked:Lock statecritical:Criticalcycle_delay:Outlet cycle delay, if anycycle:Cycle
can_read:index
Outlet access permissionsFullNoneOutlet access levels
can_read
Agent identifier
can_write
Retrieving the value is denied if any of the following is true:
• outlet access permissions is equal to false
• all of the following is true:
– outlet access permissions is not equal to true
– not outlet access permissions[index of outlet]
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 19
Changing the value is denied if agent identifier is not equal to relay
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Locked The outlet state cannot be changed
constant false Unlocked The outlet state can be changed
Sample uom library write command (note that _outlet_index is a variable):
uom.relay.outlets[_outlet_index].locked=false
Sample uom library read command (note that _outlet_index is a variable):
print(uom.dump(uom.relay.outlets[_outlet_index].locked))
⇒true
Browse more samples
2.11 Outlet: Critical
sum (boolean) relay/outlets/N/critical/
Flag indicating whether the outlet is critical, and turning it off should ask for confirmation
DLI V222 Object Model Reference: 20210317T201932Z
20 CONTENTS
CriticalCriticalNoncritical
Administrative userAdministratorRegular user
can_write
Outlet access permissionsFullNoneOutlet access levels
can_read
Outletname:Namestate:Configured statetransient_state:Transient statephysical_state:Physical statelocked:Lock statecritical:Criticalcycle_delay:Outlet cycle delay, if anycycle:Cycle
can_read:index
Retrieving the value is denied if any of the following is true:
• outlet access permissions is equal to false
• all of the following is true:
– outlet access permissions is not equal to true
– not outlet access permissions[index of outlet]
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Critical Confirmation requested to change the outlet state
constant false Noncritical No confirmation is needed to change the outlet state
Sample CLI read command (note that outlet_index is a variable):
uom get "relay/outlets/${outlet_index}/critical"
⇒
false
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 21
Sample curl read command (note that :outlet_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/outlets/:outlet_index/critical/"
⇒false
Browse more samples
2.12 Outlet: Outlet cycle delay, if any
sum (optional number) relay/outlets/N/cycle_delay/
Outlet cycle delay, in seconds, if any
Outlet cycle delay, if anyUse default cycle delayOutlet cycle delay
Administrative userAdministratorRegular user
can_write
Outlet access permissionsFullNoneOutlet access levels
can_read
Outletname:Namestate:Configured statetransient_state:Transient statephysical_state:Physical statelocked:Lock statecritical:Criticalcycle_delay:Outlet cycle delay, if anycycle:Cycle
can_read:index
Retrieving the value is denied if any of the following is true:
• outlet access permissions is equal to false
• all of the following is true:
– outlet access permissions is not equal to true
– not outlet access permissions[index of outlet]
DLI V222 Object Model Reference: 20210317T201932Z
22 CONTENTS
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Use default cycle delay Use unit default cycle delay
number Outlet cycle delay Outlet cycle delay, in seconds the value is greater than 0
Sample curl write command (note that :outlet_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 "3" "http ←↩↪→ ://192.168.0.100/restapi/relay/outlets/:outlet_index/cycle_delay/"
Sample CLI read command (note that outlet_index is a variable):
uom get "relay/outlets/${outlet_index}/cycle_delay"
⇒null
Browse more samples
2.13 Outlet: Cycle
call relay/outlets/N/cycle/
Turns the outlet off, then on again after the cycle delay passes. Has no effect when the outlet is already off.Signals an error if the outlet is locked. Does not turn the outlet back on if it becomes locked
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 23
Cycle
Outletname:Namestate:Configured statetransient_state:Transient statephysical_state:Physical statelocked:Lock statecritical:Criticalcycle_delay:Outlet cycle delay, if anycycle:Cycle
can_invoke:index
Outlet access permissionsFullNoneOutlet access levels
can_invoke
Lock stateLockedUnlocked
can_invoke
Performing the function call is denied if any of the following is true:
• any of the following is true:
– outlet access permissions is equal to false
– all of the following is true:
* outlet access permissions is not equal to true
* not outlet access permissions[index of outlet]
• lock state
The call has no arguments (supply empty tuple).
The call returns the following results:
1. Action performed: Started or No action taken
Sample requests invocation (note that _outlet_index is a variable):
print(requests.post('http://192.168.0.100/restapi/relay/outlets/'+str( ←↩↪→ _outlet_index)+'/cycle/',auth=auth,headers=headers,json={}).json())
⇒True
Sample CLI invocation (note that outlet_index is a variable):
uom invoke "relay/outlets/${outlet_index}/cycle"
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
24 CONTENTS
2.13.1 Action performed
sum (boolean) relay/outlets/N/cycle/results: 1/
Flag indicating whether the call affected the outlet state
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true Started The outlet was on and the cycle has started
constant false No action taken The outlet was off or already in a cycle, so the call hadno effect
2.14 Outlet ON sequence delay
number relay/sequence_delay/
Time after switching an outlet on during which switching outlets on is delayed to prevent simultaneous inrushcurrents on power-on
Outlet ON sequence delay
Minimal ON sequence delaycheck
Administrative userAdministratorRegular user
can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater or equal to minimal ON sequence delay
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample CLI write command:
uom set "relay/sequence_delay" "5"
Sample JS request write command:
request.put({url:"relay/sequence_delay/",body:5});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 25
2.15 Minimal ON sequence delay
number relay/min_sequence_delay/
The minimal time after switching an outlet on during which switching outlets on is delayed
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater or equal to 0
This number does not support direct modification.
This number represents a value in persistent storage.
Sample JS request read command:
request.get({url:"relay/min_sequence_delay/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒1
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/min_sequence_delay/"
⇒1
Browse more samples
2.16 Default outlet cycle delay
number relay/cycle_delay/
Time between switching an outlet off and turning it back on during cycling, which allows the controlled device toreally power down
Default outlet cycle delay Administrative userAdministratorRegular user
can_write
DLI V222 Object Model Reference: 20210317T201932Z
26 CONTENTS
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/relay/cycle_delay/',auth=auth, ←↩↪→ headers=headers).json())
⇒3
Sample CLI write command:
uom set "relay/cycle_delay" "7"
Browse more samples
2.17 Brown-out re-latch delay
number relay/relatch/
Time to wait before relatching relays on brown-out
Brown-out re-latch delay Administrative userAdministratorRegular user
can_read,can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample JS request read command:
request.get({url:"relay/relatch/"},function(error,response,body) {console.log( ←↩↪→ body)});
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 27
⇒6
Sample requests write command:
requests.put('http://192.168.0.100/restapi/relay/relatch/',auth=auth,headers= ←↩↪→ headers,json=9)
Browse more samples
2.18 Recovery mode
sum (enumerated number) relay/recovery_mode/
Outlet power-off recovery state policy
Recovery modeAll outlets offAll outlets onPre-powerloss state
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant 0 All outlets off All outlets remain powered off at power-up
constant 1 All outlets on All outlets are switched on in sequence during power-up
constant 2 Pre-powerloss state Outlets are returned to configured pre-powerloss stateduring power-up
Sample JS request write command:
request.put({url:"relay/recovery_mode/",body:2});
Sample CLI read command:
uom get "relay/recovery_mode"
⇒
DLI V222 Object Model Reference: 20210317T201932Z
28 CONTENTS
1
Browse more samples
2.19 Buses
array relay/buses/
Buses powering the relay
Busoutlet_indices:Outlet listvoltage_affects_outlets:Voltage-affected outletsmin_voltage:Minimum voltage, if anymax_voltage:Maximum voltage, if anycurrent_affects_outlets:Current-affected outletsmax_current:Maximum current, if any
Buses[element]:Bus 0..*
check
This array does not support direct modification.
This array represents a value in persistent storage.
This array contains Bus elements.
Creating elements in this collection is not supported.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/relay/buses/',auth=auth,headers= ←↩↪→ headers).json())
⇒
Sample CLI read command:
uom get "relay/buses"
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 29
2.19.1 Bus
object relay/buses/N/
Object representing bus state and configuration
Outlet list[element]:Outlet index
check
Voltage-affected outlets[element]:Outlet list index
check
Administrative userAdministratorRegular user
can_read,can_write
Current-affected outlets[element]:Outlet list index
can_read,can_writecheck
Busoutlet_indices:Outlet listvoltage_affects_outlets:Voltage-affected outletsmin_voltage:Minimum voltage, if anymax_voltage:Maximum voltage, if anycurrent_affects_outlets:Current-affected outletsmax_current:Maximum current, if any
This object contains the following items:
outlet_indices Outlet listvoltage_affects_outlets Voltage-affected outlets
min_voltage Minimum voltage, if any
max_voltage Maximum voltage, if any
current_affects_outlets Current-affected outletsmax_current Maximum current, if any
Sample requests read command (note that _bus_index is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/buses/'+str(_bus_index) ←↩↪→ +'/',auth=auth,headers=headers).json())
⇒{'outlet_indices': [0, 1, 2, 3], 'voltage_affects_outlets': [1, 2, 3], ' ←↩
↪→ max_current': 5, 'current_affects_outlets': [0], 'max_voltage': None, ' ←↩↪→ min_voltage': 60}
Sample curl write command (note that :bus_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 "{\"outlet_indices ←↩↪→ \":[0,1,2,3],\"voltage_affects_outlets\":[1,2,3],\"max_current\":5,\" ←↩↪→ current_affects_outlets\":[0],\"max_voltage\":null,\"min_voltage\":60}" " ←↩↪→ http://192.168.0.100/restapi/relay/buses/:bus_index/"
Browse more samples
See also Bus: Outlet list
See also Bus: Voltage-affected outlets
DLI V222 Object Model Reference: 20210317T201932Z
30 CONTENTS
See also Bus: Minimum voltage, if any
See also Bus: Maximum voltage, if any
See also Bus: Current-affected outlets
See also Bus: Maximum current, if any
2.20 Bus: Outlet list
array relay/buses/N/outlet_indices/
List of outlets connected to the bus
This array is composite, i.e. is modified as a whole.
This array does not support direct modification.
This array represents a value in persistent storage.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be suppliedmore than once).
This array contains Outlet index elements.
Creating elements in this collection is not supported.
Sample curl read command (note that :bus_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/buses/:bus_index/outlet_indices/"
⇒[0,1,2,3]
Sample requests read command (note that _bus_index is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/buses/'+str(_bus_index)+'/ ←↩↪→ outlet_indices/',auth=auth,headers=headers).json())
⇒[4, 5, 6, 7]
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 31
2.20.1 Outlet index
number relay/buses/N/outlet_indices/N/
Index of outlet connected to the bus
Outlet index
Outlets[element]:Outlet
check
Outlet list[element]:Outlet index
check
The value is subject to the following constraints: all of the following is true:
• outlets[the value]
• outlet list are distinct
This number is a part of a composite value which is modified as a whole.
This number does not support direct modification.
This number represents a value in persistent storage.
Sample JS request read command (note that _bus_index and _outlet_index_index are variables):
request.get({url:"relay/buses/"+_bus_index.toString()+"/outlet_indices/"+ ←↩↪→ _outlet_index_index.toString()+"/"},function(error,response,body) {console. ←↩↪→ log(body)});
⇒4
Sample requests read command (note that _bus_index and _outlet_index_index are variables):
print(requests.get('http://192.168.0.100/restapi/relay/buses/'+str(_bus_index)+'/ ←↩↪→ outlet_indices/'+str(_outlet_index_index)+'/',auth=auth,headers=headers). ←↩↪→ json())
⇒0
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
32 CONTENTS
2.21 Bus: Voltage-affected outlets
array relay/buses/N/voltage_affects_outlets/
List of outlets affected by over/undervoltage
Voltage-affected outlets[element]:Outlet list index
check
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be suppliedmore than once).
This array contains Outlet list index elements.
Sample requests write command (note that _bus_index is a variable):
requests.put('http://192.168.0.100/restapi/relay/buses/'+str(_bus_index)+'/ ←↩↪→ voltage_affects_outlets/',auth=auth,headers=headers,json=[1, 2, 3])
Sample requests outlet list index creation command (note that _bus_index is a variable):
requests.post('http://192.168.0.100/restapi/relay/buses/'+str(_bus_index)+'/ ←↩↪→ voltage_affects_outlets/',auth=auth,headers=headers,json=3)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 33
2.21.1 Outlet list index
number relay/buses/N/voltage_affects_outlets/N/
Index of outlet in the bus outlet list
Outlet list index
Voltage-affected outlets[element]:Outlet list index
check
Outlet list[element]:Outlet index
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: all of the following is true:
• outlet list[the value]
• voltage-affected outlets are distinct
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
Sample curl deletion command (note that :bus_index and :outlet_list_index_index are URL tem-plate arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X DELETE -H "Accept: application/json ←↩↪→ " "http://192.168.0.100/restapi/relay/buses/:bus_index/ ←↩↪→ voltage_affects_outlets/:outlet_list_index_index/"
Sample requests deletion command (note that _bus_index and _outlet_list_index_index arevariables):
requests.delete('http://192.168.0.100/restapi/relay/buses/'+str(_bus_index)+'/ ←↩↪→ voltage_affects_outlets/'+str(_outlet_list_index_index)+'/',auth=auth, ←↩↪→ headers=headers)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
34 CONTENTS
2.22 Bus: Minimum voltage, if any
sum (optional number) relay/buses/N/min_voltage/
The minimum voltage, below which the affected bus outlets are switched off, if any
Minimum voltage, if anyNo minimum voltageMinimum voltage
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null No minimum voltage Undervoltage doesn't affect any outlets
number Minimum voltage The minimum voltage, belowwhich the affected bus outlets areswitched off
the value is greater or equal to 0
Sample requests write command (note that _bus_index is a variable):
requests.put('http://192.168.0.100/restapi/relay/buses/'+str(_bus_index)+'/ ←↩↪→ min_voltage/',auth=auth,headers=headers,json=60)
Sample requests read command (note that _bus_index is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/buses/'+str(_bus_index)+'/ ←↩↪→ min_voltage/',auth=auth,headers=headers).json())
⇒60
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 35
2.23 Bus: Maximum voltage, if any
sum (optional number) relay/buses/N/max_voltage/
The maximum voltage, above which the affected bus outlets are switched off, if any
Maximum voltage, if anyNo maximum voltageMaximum voltage
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null No maximum voltage Overvoltage doesn't affect any outlets
number Maximum voltage The maximum voltage, abovewhich the affected bus outlets areswitched off
the value is greater or equal to 0
Sample requests read command (note that _bus_index is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/buses/'+str(_bus_index)+'/ ←↩↪→ max_voltage/',auth=auth,headers=headers).json())
⇒None
Sample CLI write command (note that bus_index is a variable):
uom set "relay/buses/${bus_index}/max_voltage" "null"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
36 CONTENTS
2.24 Bus: Current-affected outlets
array relay/buses/N/current_affects_outlets/
List of outlets affected by overcurrent
Current-affected outlets[element]:Outlet list index
check
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be suppliedmore than once).
This array contains Outlet list index elements.
Sample JS request outlet list index creation command (note that _bus_index is a variable):
request.post({url:"relay/buses/"+_bus_index.toString()+"/current_affects_outlets ←↩↪→ /",body:2});
Sample JS request write command (note that _bus_index is a variable):
request.put({url:"relay/buses/"+_bus_index.toString()+"/current_affects_outlets ←↩↪→ /",body:[0]});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 37
2.24.1 Outlet list index
number relay/buses/N/current_affects_outlets/N/
Index of outlet in the bus outlet list
Outlet list index
Current-affected outlets[element]:Outlet list index
check
Outlet list[element]:Outlet index
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: all of the following is true:
• outlet list[the value]
• current-affected outlets are distinct
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
Sample CLI write command (note that bus_index and outlet_list_index_index are variables):
uom set "relay/buses/${bus_index}/current_affects_outlets/${ ←↩↪→ outlet_list_index_index}" "0"
Sample uom library deletion command (note that _bus_index and _outlet_list_index_index arevariables):
local composite=uom.copy(uom.relay.buses[_bus_index].current_affects_outlets)uom.remove(composite,_outlet_list_index_index)uom.relay.buses[_bus_index].current_affects_outlets=composite
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
38 CONTENTS
2.25 Bus: Maximum current, if any
sum (optional number) relay/buses/N/max_current/
The maximum current, above which the affected bus outlets are switched off, if any
Maximum current, if anyNo maximum currentMaximum current
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null No maximum current Overcurrent doesn't affect any outlets
number Maximum current The maximum current, abovewhich the affected bus outlets areswitched off
the value is greater or equal to 0
Sample uom library read command (note that _bus_index is a variable):
print(uom.dump(uom.relay.buses[_bus_index].max_current))
⇒14
Sample uom library write command (note that _bus_index is a variable):
uom.relay.buses[_bus_index].max_current=5
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 39
2.26 Ports
map relay/ports/
I/O ports attached to the relay
I/O portname:Nametype:Typeconfiguration:Configurationaccept:Data reception masksend:Send datalatest_received:Latest received dataget_receive_history:Get receive historyclear_receive_history:Clear received data history
Ports[element]:I/O port
0..*
Administrative userAdministratorRegular user
can_read,can_write
Agent identifierreadonly
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This map does not support direct modification if agent identifier is not equal to relay.
This map contains I/O port elements.
Sample uom library I/O port creation command:
uom.insert(uom.relay.ports,"uart_k3",{accept={},configuration={},latest_received ←↩↪→ ={d="6683DB53BB0A"},name="uart_k3",type="uart"})
Sample uom library read command:
print(uom.dump(uom.relay.ports))
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
40 CONTENTS
2.26.1 I/O port
object relay/ports/S/
Object representing an I/O port and its channels
Configuration[element]:Configuration value
Administrative userAdministratorRegular user
can_read,can_write
Data reception mask[element]:Enable
can_read,can_write
Latest received data[element]:Data string
can_read,can_write
Agent identifierreadonly
I/O portname:Nametype:Typeconfiguration:Configurationaccept:Data reception mask
send ( Data ) -> ( Empty result )
latest_received:Latest received data
get_receive_history ( Data start time, if any Data end time, if any ) -> ( Data history )
clear_receive_history () -> ( Empty result )
This object contains the following items:
name Nametype Type
configuration Configuration
accept Data reception mask
send Send datalatest_received Latest received dataget_receive_history Get receive history
clear_receive_history Clear received data history
Sample uom library read command (note that _i_o_port is a variable):
print(uom.dump(uom.relay.ports[_i_o_port]))
⇒{accept={d=true},configuration={parity="S"},latest_received={},name="uart_jx", ←↩
↪→ type="uart"}
Sample uom library write command (note that _i_o_port is a variable):
uom.relay.ports[_i_o_port]={accept={d=true},configuration={baudrate="5",parity="E ←↩↪→ ",stop_bits="1.5"},latest_received={d=""},name="uart_6",type="uart"}
Browse more samples
See also I/O port: Name
See also I/O port: Type
See also I/O port: Configuration
See also I/O port: Data reception mask
See also I/O port: Send data
See also I/O port: Latest received data
See also I/O port: Get receive history
See also I/O port: Clear received data history
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 41
2.27 I/O port: Name
string relay/ports/S/name/
User-visible port name
Name Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample requests read command (note that _i_o_port is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/ports/'+_i_o_port+'/name ←↩↪→ /',auth=auth,headers=headers).json())
⇒'uart_548399tl9bucrc'
Sample requests write command (note that _i_o_port is a variable):
requests.put('http://192.168.0.100/restapi/relay/ports/'+_i_o_port+'/name/',auth= ←↩↪→ auth,headers=headers,json='uart_8t6803')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
42 CONTENTS
2.28 I/O port: Type
string relay/ports/S/type/
Port type
Type
check
Administrative userAdministratorRegular user
can_read,can_write
Agent identifierreadonly
Port types[element]:I/O port type
check
The value is subject to the following constraints: port types[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string does not support direct modification if agent identifier is not equal to relay.
Sample requests read command (note that _i_o_port is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/ports/'+_i_o_port+'/type ←↩↪→ /',auth=auth,headers=headers).json())
⇒'uart'
Sample CLI read command (note that i_o_port is a variable):
uom get "relay/ports/${i_o_port}/type"
⇒"uart"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 43
2.29 I/O port: Configuration
map relay/ports/S/configuration/
Port configuration
Configuration[element]:Configuration value
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This map represents a value in persistent storage.
This map can change as if by itself or indirectly because of other actions.
This map contains Configuration value elements.
Sample requests configuration value creation command (note that _i_o_port is a variable):
requests.put('http://192.168.0.100/restapi/relay/ports/'+_i_o_port+'/ ←↩↪→ configuration/char_size/',auth=auth,headers=headers,json='5')
Sample curl read command (note that :i_o_port is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/ports/:i_o_port/configuration/"
⇒{"stop_bits":"1","char_size":"8"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
44 CONTENTS
2.29.1 Configuration value
string relay/ports/S/configuration/S/
Value of a configuration item
Configuration value
Port types[element]:I/O port type
check
Typecheck
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches port types[type].data_items[index of thevalue].regexp
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
Sample CLI write command (note that i_o_port and configuration_value are variables):
uom set "relay/ports/${i_o_port}/configuration/${configuration_value}" "\"914\""
Sample CLI deletion command (note that i_o_port and configuration_value are variables):
uom remove "relay/ports/${i_o_port}/configuration/${configuration_value}"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 45
2.30 I/O port: Data reception mask
map relay/ports/S/accept/
Mask of channels to receive data from
Data reception mask[element]:Enable
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This map represents a value in persistent storage.
This map contains Enable elements.
Sample JS request enable creation command (note that _i_o_port is a variable):
request.put({url:"relay/ports/"+_i_o_port+"/accept/d/",body:true});
Sample CLI read command (note that i_o_port is a variable):
uom get "relay/ports/${i_o_port}/accept"
⇒{"d":true}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
46 CONTENTS
2.30.1 Enable
constant true relay/ports/S/accept/S/
Enable reception from this channel
Enable
Port types[element]:I/O port type
check
Type
check
The value is subject to the following constraints: port types[type].channels[index of the value]
Sample JS request deletion command (note that _i_o_port and _enable are variables):
request.delete({url:"relay/ports/"+_i_o_port+"/accept/"+_enable+"/"});
Sample curl write command (note that :i_o_port and :enable are URL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "true" "http ←↩↪→ ://192.168.0.100/restapi/relay/ports/:i_o_port/accept/:enable/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 47
2.31 I/O port: Send data
call relay/ports/S/send/
Write data to port's channels
Data[element]:Data string
Send data
argument
Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if not administrative user
The call accepts the following arguments:
1. Data: map of "string"
The call returns the following results:
1. Empty result: null
Sample requests invocation (note that _i_o_port is a variable):
requests.post('http://192.168.0.100/restapi/relay/ports/'+_i_o_port+'/send/',auth ←↩↪→ =auth,headers=headers,json={})
⇒(no output)
Sample curl invocation (note that :i_o_port 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/relay/ports/:i_o_port/send/"
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
48 CONTENTS
2.31.1 Data
map relay/ports/S/send/arguments: 1/
Data to write, indexed by channel
This map does not correspond to an actual resource.
This map contains Data string elements.
2.31.1.1 Data string
string relay/ports/S/send/arguments: 1/S/
Channel send data, hex-encoded
Data string
Port types[element]:I/O port type
check
Type
check
The value is subject to the following constraints: all of the following is true:
• port types[type].channels[index of the value]
• the value matches ∧([0-9A-Fa-f]{2})∗$
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 49
2.31.2 Empty result
constant null relay/ports/S/send/results: 1/
No additional information available
This constant does not correspond to an actual resource.
2.32 I/O port: Latest received data
map relay/ports/S/latest_received/
Latest data received, indexed by channel
Latest received data[element]:Data string
Administrative userAdministratorRegular user
can_read,can_write
Agent identifier
readonly
Retrieving the value is denied if not administrative user
Changing 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 if agent identifier is not equal to relay.
Changes to this map may have an effect besides setting value.
This map contains Data string elements.
Sample uom library data string creation command (note that _i_o_port is a variable):
local composite=uom.copy(uom.relay.ports[_i_o_port].latest_received)uom.insert(composite,"d","C7")uom.relay.ports[_i_o_port].latest_received=composite
Sample JS request write command (note that _i_o_port is a variable):
request.put({url:"relay/ports/"+_i_o_port+"/latest_received/",body:{"d":"86FF67 ←↩↪→ "}});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
50 CONTENTS
2.32.1 Data string
string relay/ports/S/latest_received/S/
Channel received data, hex-encoded
Data string
Port types[element]:I/O port type
check
Typecheck
Agent identifier
readonly
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: all of the following is true:
• port types[type].channels[index of the value]
• the value matches ∧([0-9A-Fa-f]{2})∗$
Retrieving the value is denied if not administrative user
Changing 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 if agent identifier is not equal to relay.
Changes to this string may have an effect besides setting value.
Sample JS request write command (note that _i_o_port and _data_string are variables):
request.put({url:"relay/ports/"+_i_o_port+"/latest_received/"+_data_string+"/", ←↩↪→ body:[]});
Sample requests read command (note that _i_o_port and _data_string are variables):
print(requests.get('http://192.168.0.100/restapi/relay/ports/'+_i_o_port+'/ ←↩↪→ latest_received/'+_data_string+'/',auth=auth,headers=headers).json())
⇒{}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 51
2.33 Received data element: Reception time
number relay/ports/S/get_receive_history/results: 1/N/1/
Timestamp of the received data
The value represents time, the standard unit of which is the second (s).
This number does not correspond to an actual resource.
2.34 Received data element: Received data
map relay/ports/S/get_receive_history/results: 1/N/2/
Historical data received, indexed by channel
This map does not correspond to an actual resource.
This map contains Data string elements.
2.34.1 Data string
string relay/ports/S/get_receive_history/results: 1/N/2/S/
Channel received data, hex-encoded
Data string
Port types[element]:I/O port type
check
Typecheck
Agent identifier
readonly
Administrative userAdministratorRegular user
can_read,can_write
DLI V222 Object Model Reference: 20210317T201932Z
52 CONTENTS
The value is subject to the following constraints: all of the following is true:
• port types[type].channels[index of the value]
• the value matches ∧([0-9A-Fa-f]{2})∗$
This string does not correspond to an actual resource.
This string does not support direct modification if agent identifier is not equal to relay.
Changes to this string may have an effect besides setting value.
2.35 I/O port: Get receive history
call relay/ports/S/get_receive_history/
Get history of data received over a specific time range
Data history[element]:Received data element
Get receive history
result
Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if not administrative user
The call accepts the following arguments:
1. Data start time, if any: Beginning of time or Data start time
2. Data end time, if any: Now or Data end time
The call returns the following results:
1. Data history: array of "(number,map of "string")"
Sample CLI invocation (note that i_o_port is a variable):
uom invoke "relay/ports/${i_o_port}/get_receive_history" "1234495527" "null"
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 53
⇒[[1234507866.4737,{"d":""}],[1234516092.7895,{"d":"550232"}],[1234528432.2632,{"d ←↩
↪→ ":"B5"}],[1234536658.5789,{"d":""}],[1234548998.0526,{"d":"A199 ←↩↪→ "}],[1234565450.6842,{"d":"270E8684C58F"}],[1234569563.8421,{"d":""}]]
Sample curl invocation (note that :i_o_port 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 "[1234539427,null]" "http ←↩↪→ ://192.168.0.100/restapi/relay/ports/:i_o_port/get_receive_history/"
⇒
Browse more samples
2.35.1 Data start time, if any
sum (optional number) relay/ports/S/get_receive_history/arguments: 1/
Requested timestamp of the first data element to retrieve, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Beginning of time Return data starting from the oldest available
number Data start time Requested timestamp of the first data element to re-trieve
DLI V222 Object Model Reference: 20210317T201932Z
54 CONTENTS
2.35.2 Data end time, if any
sum (optional number) relay/ports/S/get_receive_history/arguments: 2/
Requested timestamp of the last data element to retrieve, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Now Return data up to the most recent available
number Data end time Requested timestamp of the last data element to re-trieve
2.35.3 Data history
array relay/ports/S/get_receive_history/results: 1/
Historical received data elements
Received data element0:Reception time1:Received data
Data history[element]:Received data element 0..*
This array does not correspond to an actual resource.
This array contains Received data element elements.
2.35.3.1 Received data element
tuple relay/ports/S/get_receive_history/results: 1/N/
Historical data element received
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 55
Received data[element]:Data string
Received data element0:Reception time1:Received data
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 Reception time
2 Received data
See also Received data element: Reception time
See also Received data element: Received data
2.36 I/O port: Clear received data history
call relay/ports/S/clear_receive_history/
Clear the complete history of received data
Clear received data history Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if not administrative user
The call has no arguments (supply empty tuple).
The call returns the following results:
DLI V222 Object Model Reference: 20210317T201932Z
56 CONTENTS
1. Empty result: null
Sample curl invocation (note that :i_o_port 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/relay/ports/:i_o_port/clear_receive_history/"
⇒null
Sample CLI invocation (note that i_o_port is a variable):
uom invoke "relay/ports/${i_o_port}/clear_receive_history"
⇒(no output)
Browse more samples
2.36.1 Empty result
constant null relay/ports/S/clear_receive_history/results: 1/
No additional information available
This constant does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 57
2.37 Port types
map relay/known_port_types/
Known I/O port types
I/O port typedata_items:Configuration structurechannels:Channel map
Port types[element]:I/O port type
0..*
check
Administrative userAdministratorRegular user
can_read,can_write
Agent identifierreadonly
Retrieving the value is denied if not administrative user
Changing 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 if agent identifier is not equal to relay.
This map contains I/O port type elements.
Sample uom library I/O port type creation command:
local composite=uom.copy(uom.relay.known_port_types)uom.insert(composite,"uart",{channels={d="Data"},data_items={baudrate={name="Baud ←↩
↪→ rate",regexp="^[1-9][0-9]*$"},char_size={name="Character size in bits", ←↩↪→ regexp="^(5|6|7|8)$"},parity={name="Parity setting: N for none, E for even, ←↩↪→ O for odd, M for mark, S for space",regexp="^(N|E|O|M|S)$"},stop_bits={ ←↩↪→ name="Number of stop bits",regexp="^(1|2|1\\.5)$"}}})
uom.relay.known_port_types=composite
Sample JS request write command:
request.put({url:"relay/known_port_types/",body:{"uart":{"data_items":{"baudrate ←↩↪→ ":{"name":"Baud rate","regexp":"^[1-9][0-9]*$"},"char_size":{"name":" ←↩↪→ Character size in bits","regexp":"^(5|6|7|8)$"},"stop_bits":{"name":"Number ←↩↪→ of stop bits","regexp":"^(1|2|1\\.5)$"},"parity":{"name":"Parity setting: ←↩↪→ N for none, E for even, O for odd, M for mark, S for space","regexp":"^(N|E ←↩↪→ |O|M|S)$"}},"channels":{"d":"Data"}}}});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
58 CONTENTS
2.37.1 I/O port type
object relay/known_port_types/S/
Object representing a supported type of I/O ports
Configuration structure[element]:Configuration item properties
Administrative userAdministratorRegular user
can_read
Channel map[element]:Channel name
can_read
I/O port typedata_items:Configuration structurechannels:Channel map
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
data_items Configuration structure
channels Channel map
Sample JS request deletion command (note that _i_o_port_type is a variable):
request.delete({url:"relay/known_port_types/"+_i_o_port_type+"/"});
Sample CLI read command (note that i_o_port_type is a variable):
uom get "relay/known_port_types/${i_o_port_type}"
⇒
Browse more samples
See also I/O port type: Configuration structure
See also I/O port type: Channel map
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 59
2.38 I/O port type: Configuration structure
map relay/known_port_types/S/data_items/
Port configuration structure
Configuration item propertiesname:Nameregexp:Regular expression
Configuration structure[element]:Configuration item properties
0..*
Administrative userAdministratorRegular user
can_read
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 Configuration item properties elements.
Creating elements in this collection is not supported.
Sample CLI read command (note that i_o_port_type is a variable):
uom get "relay/known_port_types/${i_o_port_type}/data_items"
⇒
Sample JS request read command (note that _i_o_port_type is a variable):
request.get({url:"relay/known_port_types/"+_i_o_port_type+"/data_items/"}, ←↩↪→ function(error,response,body) {console.log(body)});
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
60 CONTENTS
2.38.1 Configuration item properties
object relay/known_port_types/S/data_items/S/
Properties of a configuration item
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
name Nameregexp Regular expression
Sample uom library write command (note that _i_o_port_type and _configuration_item_←↩
properties are variables):
uom.relay.known_port_types[_i_o_port_type].data_items[ ←↩↪→ _configuration_item_properties]={name="Baud rate",regexp="^[1-9][0-9]*$"}
Sample JS request write command (note that _i_o_port_type and _configuration_item_←↩
properties are variables):
request.put({url:"relay/known_port_types/"+_i_o_port_type+"/data_items/"+ ←↩↪→ _configuration_item_properties+"/",body:{"name":"Baud rate","regexp ←↩↪→ ":"^[1-9][0-9]*$"}});
Browse more samples
2.38.1.1 Name
string relay/known_port_types/S/data_items/S/name/
Name of the data item
Name Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string is a part of a composite value which is modified as a whole.
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 61
This string does not support direct modification.
Sample JS request read command (note that _i_o_port_type and _configuration_item_←↩
properties are variables):
request.get({url:"relay/known_port_types/"+_i_o_port_type+"/data_items/"+ ←↩↪→ _configuration_item_properties+"/name/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"Baud rate"
Sample curl read command (note that :i_o_port_type and :configuration_item_propertiesare URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/known_port_types/:i_o_port_type/data_items/: ←↩↪→ configuration_item_properties/name/"
⇒"Baud rate"
Browse more samples
2.38.1.2 Regular expression
string relay/known_port_types/S/data_items/S/regexp/
Regular expression which the data item must match
Regular expression Administrative userAdministratorRegular user
can_read
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 i_o_port_type and configuration_item_properties arevariables):
uom get "relay/known_port_types/${i_o_port_type}/data_items/${ ←↩↪→ configuration_item_properties}/regexp"
DLI V222 Object Model Reference: 20210317T201932Z
62 CONTENTS
⇒"^[1-9][0-9]*$"
Sample requests read command (note that _i_o_port_type and _configuration_item_←↩
properties are variables):
print(requests.get('http://192.168.0.100/restapi/relay/known_port_types/'+ ←↩↪→ _i_o_port_type+'/data_items/'+_configuration_item_properties+'/regexp/', ←↩↪→ auth=auth,headers=headers).json())
⇒'^[1-9][0-9]*$'
Browse more samples
2.39 I/O port type: Channel map
map relay/known_port_types/S/channels/
Map of channels supported by the port
Channel map[element]:Channel name
Administrative userAdministratorRegular user
can_read
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 Channel name elements.
Creating elements in this collection is not supported.
Sample CLI read command (note that i_o_port_type is a variable):
uom get "relay/known_port_types/${i_o_port_type}/channels"
⇒{"d":"Data"}
Sample curl read command (note that :i_o_port_type is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/known_port_types/:i_o_port_type/channels/"
⇒{"d":"Data"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 63
2.39.1 Channel name
string relay/known_port_types/S/channels/S/
Description of the channel
Channel name Administrative userAdministratorRegular user
can_read
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 :i_o_port_type and :channel_name are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/known_port_types/:i_o_port_type/channels/:channel_name/"
⇒"Data"
Sample requests read command (note that _i_o_port_type and _channel_name are variables):
print(requests.get('http://192.168.0.100/restapi/relay/known_port_types/'+ ←↩↪→ _i_o_port_type+'/channels/'+_channel_name+'/',auth=auth,headers=headers). ←↩↪→ json())
⇒'Data'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
64 CONTENTS
2.40 Pins
map relay/pins/
GPIO pins attached to the relay
GPIO pinname:Nameinput_bits:Input bitsmode_bits:Mode bitslevel_bits:Level bitsmode_driver:Mode driverlevel_driver:Level driverdrive_logic_mapping:Pin drive mappinglatest_input_value:Latest input value, if anyconfigure_input_tracking:Configure trackingconfigure_mode_driver:Configure mode driverconfigure_level_driver:Configure level driver
Pins[element]:GPIO pin
0..*
Administrative userAdministratorRegular user
can_read,can_write
Agent identifierreadonly
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This map does not support direct modification if agent identifier is not equal to relay.
This map contains GPIO pin elements.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/relay/pins/',auth=auth,headers= ←↩↪→ headers).json())
⇒{'aout8': {'level_bits': 0, 'latest_input_value': None, 'name': 'aout8', ' ←↩
↪→ drive_logic_mapping': ['Z', 'Z', 'Z', 'Z'], 'mode_driver': 'kwtfw5', ' ←↩↪→ mode_bits': 1, 'level_driver': True, 'input_bits': 0}}
Sample CLI read command:
uom get "relay/pins"
⇒...
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 65
2.40.1 GPIO pin
object relay/pins/S/
Object representing state and configuration of a GPIO pin
Pin drive mapping0:Low mode, low level1:Low mode, high level2:High mode, low level3:High mode, high level
Administrative userAdministratorRegular user
can_read
Agent identifier
readonly
GPIO pinname:Nameinput_bits:Input bitsmode_bits:Mode bitslevel_bits:Level bitsmode_driver:Mode driverlevel_driver:Level driverdrive_logic_mapping:Pin drive mappinglatest_input_value:Latest input value, if any
configure_input_tracking ( Pin tracking configuration mode ) -> ( Net changes )
configure_mode_driver ( Desired mode driver ) -> ( Net changes )
configure_level_driver ( Desired level driver ) -> ( Net changes )
This object contains the following items:
name Nameinput_bits Input bits
mode_bits Mode bitslevel_bits Level bitsmode_driver Mode driverlevel_driver Level driverdrive_logic_mapping Pin drive mapping
latest_input_value Latest input value, if any
configure_input_tracking Configure tracking
configure_mode_driver Configure mode driver
configure_level_driver Configure level driver
Sample CLI deletion command (note that gpio_pin is a variable):
uom remove "relay/pins/${gpio_pin}"
Sample curl deletion command (note that :gpio_pin is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X DELETE -H "Accept: application/json ←↩↪→ " "http://192.168.0.100/restapi/relay/pins/:gpio_pin/"
Browse more samples
See also GPIO pin: Name
See also GPIO pin: Input bits
See also GPIO pin: Mode bits
See also GPIO pin: Level bits
DLI V222 Object Model Reference: 20210317T201932Z
66 CONTENTS
See also GPIO pin: Mode driver
See also GPIO pin: Level driver
See also GPIO pin: Pin drive mapping
See also GPIO pin: Latest input value, if any
See also GPIO pin: Configure tracking
See also GPIO pin: Configure mode driver
See also GPIO pin: Configure level driver
2.41 GPIO pin: Name
string relay/pins/S/name/
User-visible pin name
Name Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample uom library write command (note that _gpio_pin is a variable):
uom.relay.pins[_gpio_pin].name="din27"
Sample curl write command (note that :gpio_pin 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 "\"aio90\"" "http ←↩↪→ ://192.168.0.100/restapi/relay/pins/:gpio_pin/name/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 67
2.42 GPIO pin: Input bits
number relay/pins/S/input_bits/
Number of bits in pin input value
Input bits
can_invoke Administrative userAdministratorRegular user
can_read
Agent identifier
readonly
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
• the value is less or equal to 64
Retrieving the value is denied if not administrative user
This number does not support direct modification if agent identifier is not equal to relay.
This number represents a value in persistent storage.
Sample curl read command (note that :gpio_pin is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/pins/:gpio_pin/input_bits/"
⇒1
Sample curl write command (note that :gpio_pin 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 "1" "http ←↩↪→ ://192.168.0.100/restapi/relay/pins/:gpio_pin/input_bits/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
68 CONTENTS
2.43 GPIO pin: Mode bits
number relay/pins/S/mode_bits/
Number of bits in pin mode value
Mode bits
readonly,can_invoke Administrative userAdministratorRegular user
can_read
Agent identifier
readonly
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
• the value is less or equal to 64
Retrieving the value is denied if not administrative user
This number does not support direct modification if agent identifier is not equal to relay.
This number represents a value in persistent storage.
Sample CLI write command (note that gpio_pin is a variable):
uom set "relay/pins/${gpio_pin}/mode_bits" "4"
Sample uom library write command (note that _gpio_pin is a variable):
uom.relay.pins[_gpio_pin].mode_bits=0
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 69
2.44 GPIO pin: Level bits
number relay/pins/S/level_bits/
Number of bits in pin level value
Level bits
readonly,can_invoke Administrative userAdministratorRegular user
can_read
Agent identifier
readonly
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
• the value is less or equal to 64
Retrieving the value is denied if not administrative user
This number does not support direct modification if agent identifier is not equal to relay.
This number represents a value in persistent storage.
Sample uom library write command (note that _gpio_pin is a variable):
uom.relay.pins[_gpio_pin].level_bits=8
Sample CLI read command (note that gpio_pin is a variable):
uom get "relay/pins/${gpio_pin}/level_bits"
⇒2
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
70 CONTENTS
2.45 GPIO pin: Mode driver
sum (variant) relay/pins/S/mode_driver/
Configured signal driving the pin's mode (input or output)
Mode driverActiveTristatedNet nameInvalid net placeholder
Administrative userAdministratorRegular user
can_read,can_write
Nets[element]:GPIO net
check
Agent identifier
readonly
Mode bits
readonly
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum does not support direct modification if all of the following is true:
• agent identifier is not equal to relay
• mode bits is equal to 0
This sum represents a value in persistent storage.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant true Active The pin is as active (output) as possible
constant false Tristated The pin is as inactive (input, hi-Z state) as possible
string Net name Name of the net providing thedriving value
all of the following is true:
• not the value matches∧(|.∗|.∗)$
• nets[the value]
string Invalid net placeholder A placeholder for a net thathas been deleted or renamed(and always has the logical valuefalse)
the value matches ∧net_←↩
deleted:.∗$DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 71
Sample curl write command (note that :gpio_pin 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 "true" "http ←↩↪→ ://192.168.0.100/restapi/relay/pins/:gpio_pin/mode_driver/"
Sample JS request read command (note that _gpio_pin is a variable):
request.get({url:"relay/pins/"+_gpio_pin+"/mode_driver/"},function(error,response ←↩↪→ ,body) {console.log(body)});
⇒true
Browse more samples
2.46 GPIO pin: Level driver
sum (variant) relay/pins/S/level_driver/
Configured signal driving the pin's output level
Level driverHighLowNet nameInvalid net placeholder
Administrative userAdministratorRegular user
can_read,can_write
Nets[element]:GPIO net
check
Agent identifier
readonly
Level bits
readonly
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum does not support direct modification if all of the following is true:
• agent identifier is not equal to relay
DLI V222 Object Model Reference: 20210317T201932Z
72 CONTENTS
• level bits is equal to 0
This sum represents a value in persistent storage.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant true High The pin is driven as high as possible given the currentmode
constant false Low The pin is driven as low as possible given the currentmode
string Net name Name of the net providing thedriving value
all of the following is true:
• not the value matches∧(|.∗|.∗)$
• nets[the value]
string Invalid net placeholder A placeholder for a net thathas been deleted or renamed(and always has the logical valuefalse)
the value matches ∧net_←↩
deleted:.∗$
Sample curl write command (note that :gpio_pin 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 "\"f0\"" "http ←↩↪→ ://192.168.0.100/restapi/relay/pins/:gpio_pin/level_driver/"
Sample CLI write command (note that gpio_pin is a variable):
uom set "relay/pins/${gpio_pin}/level_driver" "false"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 73
2.47 GPIO pin: Pin drive mapping
tuple relay/pins/S/drive_logic_mapping/
Mapping of pin mode and level combinations to resulting pin IEEE1164 logic levels
Pin drive mapping0:Low mode, low level1:Low mode, high level2:High mode, low level3:High mode, high level
Administrative userAdministratorRegular user
can_read
Agent identifier
readonly
Retrieving the value is denied if not administrative user
This tuple is composite, i.e. is modified as a whole.
This tuple does not support direct modification if agent identifier is not equal to relay.
This tuple represents a value in persistent storage.
This tuple contains the following items:
1 Low mode, low level2 Low mode, high level
3 High mode, low level
4 High mode, high level
Sample CLI read command (note that gpio_pin is a variable):
uom get "relay/pins/${gpio_pin}/drive_logic_mapping"
⇒["Z","Z","Z","Z"]
Sample JS request write command (note that _gpio_pin is a variable):
request.put({url:"relay/pins/"+_gpio_pin+"/drive_logic_mapping/",body:["Z","H ←↩↪→ ","0","1"]});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
74 CONTENTS
2.47.1 Low mode, low level
sum (enumerated string) relay/pins/S/drive_logic_mapping/1/
IEEE1164 logic level when pin is in the minimum mode, minimum level configuration
Low mode, low levelForcing 0Forcing 1Weak 0Weak 1High impedance
Administrative userAdministratorRegular user
can_read
Agent identifier
readonly
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 if agent identifier is not equal to relay.
This sum represents a value in persistent storage.
This sum can assume the following values:
constant "0" Forcing 0 Strong low signal as good as ground
constant "1" Forcing 1 Strong high signal as good as power supply voltage
constant "L" Weak 0 Low signal which is logically 0 but weak (e.g. from apull-down resistor)
constant "H" Weak 1 High signal which is logically 1 but weak (e.g. from apull-up resistor)
constant "Z" High impedance Pin pulled neither up nor down, signal defined by ex-ternal circuitry
Sample JS request read command (note that _gpio_pin is a variable):
request.get({url:"relay/pins/"+_gpio_pin+"/drive_logic_mapping/0/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 75
"Z"
Sample JS request write command (note that _gpio_pin is a variable):
request.put({url:"relay/pins/"+_gpio_pin+"/drive_logic_mapping/0/",body:"Z"});
Browse more samples
2.47.2 Low mode, high level
sum (enumerated string) relay/pins/S/drive_logic_mapping/2/
IEEE1164 logic level when pin is in the minimum mode, maximum level configuration
Low mode, high levelForcing 0Forcing 1Weak 0Weak 1High impedance
Administrative userAdministratorRegular user
can_read
Agent identifier
readonly
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 if agent identifier is not equal to relay.
This sum represents a value in persistent storage.
This sum can assume the following values:
constant "0" Forcing 0 Strong low signal as good as ground
constant "1" Forcing 1 Strong high signal as good as power supply voltage
constant "L" Weak 0 Low signal which is logically 0 but weak (e.g. from apull-down resistor)
constant "H" Weak 1 High signal which is logically 1 but weak (e.g. from apull-up resistor)
constant "Z" High impedance Pin pulled neither up nor down, signal defined by ex-ternal circuitry
DLI V222 Object Model Reference: 20210317T201932Z
76 CONTENTS
Sample uom library read command (note that _gpio_pin is a variable):
print(uom.dump(uom.relay.pins[_gpio_pin].drive_logic_mapping[2]))
⇒"H"
Sample requests write command (note that _gpio_pin is a variable):
requests.put('http://192.168.0.100/restapi/relay/pins/'+_gpio_pin+'/ ←↩↪→ drive_logic_mapping/1/',auth=auth,headers=headers,json='H')
Browse more samples
2.47.3 High mode, low level
sum (enumerated string) relay/pins/S/drive_logic_mapping/3/
IEEE1164 logic level when pin is in the maximum mode, minimum level configuration
High mode, low levelForcing 0Forcing 1Weak 0Weak 1High impedance
Administrative userAdministratorRegular user
can_read
Agent identifier
readonly
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 if agent identifier is not equal to relay.
This sum represents a value in persistent storage.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 77
constant "0" Forcing 0 Strong low signal as good as ground
constant "1" Forcing 1 Strong high signal as good as power supply voltage
constant "L" Weak 0 Low signal which is logically 0 but weak (e.g. from apull-down resistor)
constant "H" Weak 1 High signal which is logically 1 but weak (e.g. from apull-up resistor)
constant "Z" High impedance Pin pulled neither up nor down, signal defined by ex-ternal circuitry
Sample requests read command (note that _gpio_pin is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/pins/'+_gpio_pin+'/ ←↩↪→ drive_logic_mapping/2/',auth=auth,headers=headers).json())
⇒'0'
Sample CLI write command (note that gpio_pin is a variable):
uom set "relay/pins/${gpio_pin}/drive_logic_mapping/2" "\"0\""
Browse more samples
2.47.4 High mode, high level
sum (enumerated string) relay/pins/S/drive_logic_mapping/4/
IEEE1164 logic level when pin is in the maximum mode, maximum level configuration
High mode, high levelForcing 0Forcing 1Weak 0Weak 1High impedance
Administrative userAdministratorRegular user
can_read
Agent identifier
readonly
DLI V222 Object Model Reference: 20210317T201932Z
78 CONTENTS
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 if agent identifier is not equal to relay.
This sum represents a value in persistent storage.
This sum can assume the following values:
constant "0" Forcing 0 Strong low signal as good as ground
constant "1" Forcing 1 Strong high signal as good as power supply voltage
constant "L" Weak 0 Low signal which is logically 0 but weak (e.g. from apull-down resistor)
constant "H" Weak 1 High signal which is logically 1 but weak (e.g. from apull-up resistor)
constant "Z" High impedance Pin pulled neither up nor down, signal defined by ex-ternal circuitry
Sample uom library write command (note that _gpio_pin is a variable):
uom.relay.pins[_gpio_pin].drive_logic_mapping[4]="Z"
Sample JS request read command (note that _gpio_pin is a variable):
request.get({url:"relay/pins/"+_gpio_pin+"/drive_logic_mapping/3/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒"0"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 79
2.48 GPIO pin: Latest input value, if any
sum (optional number) relay/pins/S/latest_input_value/
Latest pin input value as reported by a net, if any
Latest input value, if anyNo latest input valueLatest input value
Administrative userAdministratorRegular user
can_read,can_write
Agent identifier
readonly
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
Using the sum as a field for indexing into the grandparent collection is denied
This sum does not support direct modification if agent identifier is not equal to relay.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant null No latest input value Input value not monitored so no latest value available
number Latest input value Latest pin input value as reported by a net
Sample CLI read command (note that gpio_pin is a variable):
uom get "relay/pins/${gpio_pin}/latest_input_value"
⇒null
Sample requests read command (note that _gpio_pin is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/pins/'+_gpio_pin+'/ ←↩↪→ latest_input_value/',auth=auth,headers=headers).json())
⇒None
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
80 CONTENTS
2.49 Net changes: Removed nets
array relay/pins/S/configure_input_tracking/results: 1/1/
List of nets removed to fulfill the configuration result
This array does not correspond to an actual resource.
This array contains Removed net elements.
2.49.1 Removed net
string relay/pins/S/configure_input_tracking/results: 1/1/N/
Identifier of the removed net
This string does not correspond to an actual resource.
2.50 Net changes: Added nets
array relay/pins/S/configure_input_tracking/results: 1/2/
List of nets added to fulfill the configuration result
This array does not correspond to an actual resource.
This array contains Added net elements.
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 81
2.50.1 Added net
string relay/pins/S/configure_input_tracking/results: 1/2/N/
Identifier of the added net
This string does not correspond to an actual resource.
2.51 GPIO pin: Configure tracking
call relay/pins/S/configure_input_tracking/
Set method of reporting the pin's value
Net changes0:Removed nets1:Added nets
Configure tracking
result
Administrative userAdministratorRegular user
can_invoke
Input bits
can_invoke
Performing the function call is denied if any of the following is true:
• not administrative user
• input bits is equal to 0
The call accepts the following arguments:
1. Pin tracking configuration mode: None, Pull or Push
The call returns the following results:
DLI V222 Object Model Reference: 20210317T201932Z
82 CONTENTS
1. Net changes: (array of "string",array of "string")
Sample CLI invocation (note that gpio_pin is a variable):
uom invoke "relay/pins/${gpio_pin}/configure_input_tracking" "\"push\""
⇒[]
Sample JS request invocation (note that _gpio_pin is a variable):
request.post({url:"relay/pins/"+_gpio_pin+"/configure_input_tracking/",body:[null ←↩↪→ ]});
⇒[]
Browse more samples
2.51.1 Pin tracking configuration mode
sum (optional enumerated string) relay/pins/S/configure_input_tracking/arguments: 1/
Desired pin tracking configuration mode
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None Latest pin value is not updated
constant "pull" Pull Latest pin value is updated periodically
constant "push" Push Latest pin value is reported when changed
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 83
2.51.2 Net changes
tuple relay/pins/S/configure_input_tracking/results: 1/
Changes in net structure performed by the call
Removed nets[element]:Removed net
Added nets[element]:Added net
Net changes0:Removed nets1:Added nets
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 Removed nets2 Added nets
See also Net changes: Removed nets
See also Net changes: Added nets
DLI V222 Object Model Reference: 20210317T201932Z
84 CONTENTS
2.52 Net changes: Removed nets
array relay/pins/S/configure_mode_driver/results: 1/1/
List of nets removed to fulfill the configuration result
This array does not correspond to an actual resource.
This array contains Removed net elements.
2.52.1 Removed net
string relay/pins/S/configure_mode_driver/results: 1/1/N/
Identifier of the removed net
This string does not correspond to an actual resource.
2.53 Net changes: Added nets
array relay/pins/S/configure_mode_driver/results: 1/2/
List of nets added to fulfill the configuration result
This array does not correspond to an actual resource.
This array contains Added net elements.
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 85
2.53.1 Added net
string relay/pins/S/configure_mode_driver/results: 1/2/N/
Identifier of the added net
This string does not correspond to an actual resource.
2.54 GPIO pin: Configure mode driver
call relay/pins/S/configure_mode_driver/
Set pin's mode (input or output) driver
Net changes0:Removed nets1:Added nets
Configure mode driver
result
Administrative userAdministratorRegular user
can_invoke
Mode bits
can_invoke
Performing the function call is denied if any of the following is true:
• not administrative user
• mode bits is equal to 0
The call accepts the following arguments:
1. Desired mode driver: High, Low or Net code
The call returns the following results:
DLI V222 Object Model Reference: 20210317T201932Z
86 CONTENTS
1. Net changes: (array of "string",array of "string")
Sample JS request invocation (note that _gpio_pin is a variable):
request.post({url:"relay/pins/"+_gpio_pin+"/configure_mode_driver/",body:[false ←↩↪→ ]});
⇒[]
Sample requests invocation (note that _gpio_pin is a variable):
print(requests.post('http://192.168.0.100/restapi/relay/pins/'+_gpio_pin+'/ ←↩↪→ configure_mode_driver/',auth=auth,headers=headers,json=['m6']).json())
⇒{}
Browse more samples
2.54.1 Desired mode driver
sum (variant) relay/pins/S/configure_mode_driver/arguments: 1/
Desired signal driving the pin's mode (input or output)
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true High The pin is driven as high as possible given the currentmode
constant false Low The pin is driven as low as possible given the currentmode
string Net code Code of the net providing the driving value
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 87
2.54.2 Net changes
tuple relay/pins/S/configure_mode_driver/results: 1/
Changes in net structure performed by the call
Removed nets[element]:Removed net
Added nets[element]:Added net
Net changes0:Removed nets1:Added nets
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 Removed nets2 Added nets
See also Net changes: Removed nets
See also Net changes: Added nets
DLI V222 Object Model Reference: 20210317T201932Z
88 CONTENTS
2.55 Net changes: Removed nets
array relay/pins/S/configure_level_driver/results: 1/1/
List of nets removed to fulfill the configuration result
This array does not correspond to an actual resource.
This array contains Removed net elements.
2.55.1 Removed net
string relay/pins/S/configure_level_driver/results: 1/1/N/
Identifier of the removed net
This string does not correspond to an actual resource.
2.56 Net changes: Added nets
array relay/pins/S/configure_level_driver/results: 1/2/
List of nets added to fulfill the configuration result
This array does not correspond to an actual resource.
This array contains Added net elements.
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 89
2.56.1 Added net
string relay/pins/S/configure_level_driver/results: 1/2/N/
Identifier of the added net
This string does not correspond to an actual resource.
2.57 GPIO pin: Configure level driver
call relay/pins/S/configure_level_driver/
Set pin's output level driver
Net changes0:Removed nets1:Added nets
Configure level driver
result
Administrative userAdministratorRegular user
can_invoke
Level bits
can_invoke
Performing the function call is denied if any of the following is true:
• not administrative user
• level bits is equal to 0
The call accepts the following arguments:
1. Desired level driver: High, Low or Net code
The call returns the following results:
1. Net changes: (array of "string",array of "string")
DLI V222 Object Model Reference: 20210317T201932Z
90 CONTENTS
Sample uom library invocation (note that _gpio_pin is a variable):
print(uom.dump(uom.relay.pins[_gpio_pin].configure_level_driver(false)))
⇒{}
Sample curl invocation (note that :gpio_pin 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 "[\"q1\"]" "http://192.168.0.100/ ←↩↪→ restapi/relay/pins/:gpio_pin/configure_level_driver/"
⇒[]
Browse more samples
2.57.1 Desired level driver
sum (variant) relay/pins/S/configure_level_driver/arguments: 1/
Desired signal driving the pin's output level
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true High The pin is driven as high as possible given the currentmode
constant false Low The pin is driven as low as possible given the currentmode
string Net code Code of the net providing the driving value
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 91
2.57.2 Net changes
tuple relay/pins/S/configure_level_driver/results: 1/
Changes in net structure performed by the call
Removed nets[element]:Removed net
Added nets[element]:Added net
Net changes0:Removed nets1:Added nets
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 Removed nets2 Added nets
See also Net changes: Removed nets
See also Net changes: Added nets
DLI V222 Object Model Reference: 20210317T201932Z
92 CONTENTS
2.58 Nets
map relay/nets/
Nets controlling the GPIO pins
GPIO netname:Nameexpression:Expressiontracking:Trackinglatest_value:Latest value
Nets[element]:GPIO net
0..*
check Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This map represents a value in persistent storage.
This map contains GPIO net elements.
Sample JS request read command:
request.get({url:"relay/nets/"},function(error,response,body) {console.log(body) ←↩↪→ });
⇒
Sample uom library write command:
uom.relay.nets={b2={expression="(not net[\"zm81\"])",latest_value=0,name="b2", ←↩↪→ tracking=null},l30={expression=false,latest_value=0,name="l30",tracking=" ←↩↪→ push"},swxym41={expression=false,name="swxym41",tracking="pull"},t5={ ←↩↪→ expression="net[\"ibnz79\"]",name="t5",tracking="pull"},zcvxociv7={ ←↩↪→ expression="(not net[\"ybj97\"])",latest_value=0,name="zcvxociv7",tracking ←↩↪→ ="push"}}
Browse more samples
See also Nets: GPIO net
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 93
2.59 Nets: GPIO net
object relay/nets/S/
Object representing a state of a GPIO net signal
This object contains the following items:
name Nameexpression Expression
tracking Tracking
latest_value Latest value
Sample CLI deletion command (note that gpio_net is a variable):
uom remove "relay/nets/${gpio_net}"
Sample uom library read command (note that _gpio_net is a variable):
print(uom.dump(uom.relay.nets[_gpio_net]))
⇒{expression=false,latest_value=10,name="ck59",tracking=null}
Browse more samples
2.59.1 Name
string relay/nets/S/name/
User-visible net name
Name Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample JS request read command (note that _gpio_net is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
94 CONTENTS
request.get({url:"relay/nets/"+_gpio_net+"/name/"},function(error,response,body) ←↩↪→ {console.log(body)});
⇒"b24"
Sample requests write command (note that _gpio_net is a variable):
requests.put('http://192.168.0.100/restapi/relay/nets/'+_gpio_net+'/name/',auth= ←↩↪→ auth,headers=headers,json='vselmc5')
Browse more samples
2.59.2 Expression
string relay/nets/S/expression/
Expression governing the net's value
Expression Administrative userAdministratorRegular user
can_read,can_write
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 not administrative user
This string represents a value in persistent storage.
Sample curl write command (note that :gpio_net 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 "\"net[\\\"up5\\\"]\"" " ←↩↪→ http://192.168.0.100/restapi/relay/nets/:gpio_net/expression/"
Sample requests read command (note that _gpio_net is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/nets/'+_gpio_net+'/ ←↩↪→ expression/',auth=auth,headers=headers).json())
⇒'(neg((not shr(apin["ain14"],apin["ain52"])),apin["dout17"]) * (apin["din6"] <= ←↩
↪→ net["j95"]))'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 95
2.59.3 Tracking
sum (optional enumerated string) relay/nets/S/tracking/
Method of reporting the net's value
TrackingNonePullPush
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null None Net value is not updated
constant "pull" Pull Net value is updated periodically
constant "push" Push Net value is reported when changed
Sample JS request write command (note that _gpio_net is a variable):
request.put({url:"relay/nets/"+_gpio_net+"/tracking/",body:"pull"});
Sample curl write command (note that :gpio_net 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 "\"pull\"" "http ←↩↪→ ://192.168.0.100/restapi/relay/nets/:gpio_net/tracking/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
96 CONTENTS
2.59.4 Latest value
number relay/nets/S/latest_value/
Latest net value
Latest value
Administrative userAdministratorRegular user
can_read,can_write
Agent identifier
readonly
The value is unconditionally set to 0 on creation and doesn't have to be supplied (if it is, it must match)
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
Using the number as a field for indexing into the grandparent collection is denied
This number does not support direct modification if agent identifier is not equal to relay.
Sample curl read command (note that :gpio_net is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/nets/:gpio_net/latest_value/"
⇒2
Sample CLI read command (note that gpio_net is a variable):
uom get "relay/nets/${gpio_net}/latest_value"
⇒1
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 97
2.60 Enable measurement-driven outlet control
sum (boolean) relay/fuses_enabled/
Allow use of measurement results to conditionally switch off outlets, enabling safety shutdown and correct powerloss operation
Enable measurement-driven outlet controlEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum is expected to be visible to advanced users only.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample JS request read command:
request.get({url:"relay/fuses_enabled/"},function(error,response,body) {console. ←↩↪→ log(body)});
⇒false
Sample CLI write command:
uom set "relay/fuses_enabled" "false"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
98 CONTENTS
2.61 Minimum relay voltage, if any
sum (optional number) relay/min_relay_voltage/
Minimum relay voltage below which it cannot drive outlets and they must be considered off, if any
Minimum relay voltage, if anyDisable relay undervoltage handlingMinimum relay voltage
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum is expected to be visible to advanced users only.
This sum can assume the following values:
constant null Disable relay undervoltagehandling
Ignore relay undervoltage. This is unsafe!
number Minimum relay voltage Minimum relay voltage belowwhich it cannot drive outletsand they must be consideredoff
the value is greater than 0
Sample JS request write command:
request.put({url:"relay/min_relay_voltage/",body:8});
Sample uom library read command:
print(uom.dump(uom.relay.min_relay_voltage))
⇒8
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 99
2.62 Measurement-driven relatch timeout, if any
sum (optional number) relay/fuse_relatch/
Time to hold outlets off after switching them off due to measurement limits being hit, if any
Measurement-driven relatch timeout, if anyLatch OFFMeasurement-driven relatch timeout
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Latch OFF Switch outlets off until the user takes actionnumber Measurement-driven relatch
timeoutTime to hold outlets off af-ter switching them off due tomeasurement limits being hit
the value is greater than 0
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/relay/fuse_relatch/',auth=auth, ←↩↪→ headers=headers).json())
⇒None
Sample CLI write command:
uom set "relay/fuse_relatch" "10"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
100 CONTENTS
2.63 Keypad state
sum (boolean) relay/keypad_enabled/
Flag indicating whether keypad is enabled or disabled
Keypad stateEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample CLI read command:
uom get "relay/keypad_enabled"
⇒true
Sample CLI write command:
uom set "relay/keypad_enabled" "false"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 101
2.64 LCD all-caps filter
sum (boolean) relay/all_caps/
Flag enabling all-caps display of text
LCD all-caps filterAll CAPSStandard mode
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true All CAPS All LCD strings are displayed in capital letters
constant false Standard mode LCD strings are displayed as configured without capi-talization
Sample requests write command:
requests.put('http://192.168.0.100/restapi/relay/all_caps/',auth=auth,headers= ←↩↪→ headers,json=False)
Sample JS request read command:
request.get({url:"relay/all_caps/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
102 CONTENTS
2.65 Beep sequence
string relay/beep_sequence/
Signal sequence for beeper activation
Beep sequence Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches ∧[01. _-]∗$
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/beep_sequence/"
⇒"0"
Sample requests write command:
requests.put('http://192.168.0.100/restapi/relay/beep_sequence/',auth=auth, ←↩↪→ headers=headers,json='0')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 103
2.66 Backlight sequence
string relay/backlight_sequence/
Signal sequence for backlight blinking
Backlight sequence Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches ∧[01. _-]∗$
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/relay/backlight_sequence/',auth= ←↩↪→ auth,headers=headers).json())
⇒'0'
Sample JS request read command:
request.get({url:"relay/backlight_sequence/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"0"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
104 CONTENTS
2.67 LCD column count
number relay/lcd_columns/
Number of LCD columns
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
This number does not support direct modification.
This number represents a value in persistent storage.
Sample CLI read command:
uom get "relay/lcd_columns"
⇒16
Sample uom library read command:
print(uom.dump(uom.relay.lcd_columns))
⇒16
Browse more samples
2.68 LCD row count
number relay/lcd_rows/
Number of LCD rows
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
This number does not support direct modification.
This number represents a value in persistent storage.
Sample JS request read command:
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 105
request.get({url:"relay/lcd_rows/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒2
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/relay/lcd_rows/',auth=auth, ←↩↪→ headers=headers).json())
⇒2
Browse more samples
2.69 User LCD lines
array relay/user_lines/
Array of strings to override LCD lines with, from top to bottom
User LCD lines[element]:User LCD line, if any
LCD row countcheck
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: length of the value is equal to LCD row count
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array contains User LCD line, if any elements.
Sample requests write command:
requests.put('http://192.168.0.100/restapi/relay/user_lines/',auth=auth,headers= ←↩↪→ headers,json=[None, None])
Sample JS request write command:
request.put({url:"relay/user_lines/",body:[null,null]});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
106 CONTENTS
2.69.1 User LCD line, if any
sum (optional string) relay/user_lines/N/
The line to override the corresponding line of the LCD output with, if any
User LCD line, if anyNo user LCD lineUser LCD line
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
Changes to this sum may have an effect besides setting value.
This sum can assume the following values:
constant null No user LCD line Do not override the corresponding line of the ordinaryLCD output
string User LCD line The line to override the corresponding line of the LCDoutput with
Sample uom library read command (note that _user_lcd_line__if_any_index is a variable):
print(uom.dump(uom.relay.user_lines[_user_lcd_line__if_any_index]))
⇒null
Sample requests read command (note that _user_lcd_line__if_any_index is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/user_lines/'+str( ←↩↪→ _user_lcd_line__if_any_index)+'/',auth=auth,headers=headers).json())
⇒None
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 107
2.70 User message force display timeout, if any
sum (optional number) relay/user_message_force_timeout/
Time during which the user script LCD message always overrides ordinary LCD output, if any
User message force display timeout, if anyAlways force user messageUser message force display timeout
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Always force user message The user message always overrides ordinary LCD out-put
number User message force displaytimeout
Time during which the userscript LCD message alwaysoverrides ordinary LCD out-put
the value is greater or equal to0
Sample JS request read command:
request.get({url:"relay/user_message_force_timeout/"},function(error,response, ←↩↪→ body) {console.log(body)});
⇒2
Sample uom library write command:
uom.relay.user_message_force_timeout=null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
108 CONTENTS
2.71 User message display timeout, if any
sum (optional number) relay/user_message_timeout/
Time after which the user script LCD message is replaced by ordinary LCD output even if nothing else happens,if any
User message display timeout, if anyShow user message indefinitelyUser message display timeout
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Show user message indefi-nitely
The user message stays on LCD until ordinary LCDoutput changes
number User message display time-out
Time after which the userscript LCD message is re-placed by ordinary LCD out-put even if nothing else hap-pens
the value is greater or equal to0
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 "3" "http ←↩↪→ ://192.168.0.100/restapi/relay/user_message_timeout/"
Sample JS request write command:
request.put({url:"relay/user_message_timeout/",body:3});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 109
2.72 Notifications
object relay/notifications/
Relay-state-related notifications
Parameter kindsoutlet:Outletstate:Configured statetransient_state:Transient statephysical_state:Physical statelocked:Lock state
check
Events[element]:Event
Administrative userAdministratorRegular usercan_read
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
Retrieving the value is denied if not administrative user
This object does not support direct modification.
This object contains the following items:
parameter_kinds Parameter kinds
events Events
Sample CLI read command:
uom get "relay/notifications"
⇒...
Sample uom library read command:
print(uom.dump(uom.relay.notifications))
⇒<...>
Browse more samples
See also Notifications: Parameter kinds
DLI V222 Object Model Reference: 20210317T201932Z
110 CONTENTS
2.72.1 Events
map relay/notifications/events/
Event templates
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
Events[element]:Event
0..*
Administrative userAdministratorRegular user
can_read
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 Event elements.
Creating elements in this collection is not supported.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/relay/notifications/events/', ←↩↪→ auth=auth,headers=headers).json())
⇒<...>
Sample CLI read command:
uom get "relay/notifications/events"
⇒...
Browse more samples
See also Events: Event
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 111
2.73 Notifications: Parameter kinds
object relay/notifications/parameter_kinds/
Kinds of event parameters
This object does not correspond to an actual resource.
This object contains the following items:
outlet Outletstate Configured state
transient_state Transient statephysical_state Physical state
locked Lock state
2.73.1 Outlet
number relay/notifications/parameter_kinds/outlet/
Outlet index
Outlet Outlets[element]:Outlet
check
The value is subject to the following constraints: outlets[the value]
DLI V222 Object Model Reference: 20210317T201932Z
112 CONTENTS
2.73.2 Configured state
sum (boolean) relay/notifications/parameter_kinds/state/
Saved configured state of the outlet
This sum can assume the following values:
constant true On The outlet is powered
constant false Off The outlet is not powered
2.73.3 Transient state
sum (boolean) relay/notifications/parameter_kinds/transient_state/
Current expected state of the outlet
This sum can assume the following values:
constant true On The outlet is powered
constant false Off The outlet is not powered
2.73.4 Physical state
sum (boolean) relay/notifications/parameter_kinds/physical_state/
Current actual state of the outlet
This sum can assume the following values:
constant true On The outlet is powered
constant false Off The outlet is not powered
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 113
2.73.5 Lock state
sum (boolean) relay/notifications/parameter_kinds/locked/
Indicates whether the outlet state is locked from keypad
This sum can assume the following values:
constant true Locked The outlet state cannot be changed
constant false Unlocked The outlet state can be changed
2.74 Event parameters: Event parameter
object relay/notifications/events/S/parameters/N/
Properties of a parameter associated with the event
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
id Identifierhas_fixed_value Fixed value flag
fixed_value Fixed value
Sample curl write command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "{\"fixed_value\":null,\" ←↩↪→ has_fixed_value\":false,\"id\":\"outlet\"}" "http://192.168.0.100/restapi/ ←↩↪→ relay/notifications/events/:event/parameters/:event_parameter_index/"
Sample CLI write command (note that event and event_parameter_index are variables):
uom set "relay/notifications/events/${event}/parameters/${event_parameter_index}" ←↩↪→ "{\"fixed_value\":true,\"has_fixed_value\":true,\"id\":\"transient_state ←↩↪→ \"}"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
114 CONTENTS
2.74.1 Identifier
string relay/notifications/events/S/parameters/N/id/
Parameter identifier
Identifier
Parameter kindsoutlet:Outletstate:Configured statetransient_state:Transient statephysical_state:Physical statelocked:Lock state
check
Administrative userAdministratorRegular user
can_read
The value is subject to the following constraints: parameter kinds[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 curl read command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/notifications/events/:event/parameters/:event_parameter_index ←↩↪→ /id/"
⇒"outlet"
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.relay.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].id))
⇒"outlet"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 115
2.74.2 Fixed value flag
sum (boolean) relay/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
Fixed value flagFixedVariable
Administrative userAdministratorRegular user
can_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 Fixed The value is fixedconstant false Variable The value is variable
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.relay.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].has_fixed_value))
⇒false
Sample CLI read command (note that event and event_parameter_index are variables):
uom get "relay/notifications/events/${event}/parameters/${event_parameter_index}/ ←↩↪→ has_fixed_value"
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
116 CONTENTS
2.74.3 Fixed value
sum (variant) relay/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
Fixed valueNullTrueFalseStringNumber
Administrative userAdministratorRegular user
can_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 null Null Nullconstant true True Trueconstant false False Falsestring String This string
number Number This number
Sample CLI read command (note that event and event_parameter_index are variables):
uom get "relay/notifications/events/${event}/parameters/${event_parameter_index}/ ←↩↪→ fixed_value"
⇒null
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.relay.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].fixed_value))
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 117
⇒null
Browse more samples
2.75 Events: Event
object relay/notifications/events/S/
Event template
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
can_readcheck
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
message_template Message template
severity Severity
parameters Event parameters
Sample JS request read command (note that _event is a variable):
request.get({url:"relay/notifications/events/"+_event+"/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒{"severity":7,"message_template":["outlet ",0," expected to be OFF"],"parameters ←↩
↪→ ":[{"fixed_value":null,"has_fixed_value":false,"id":"outlet"},{"fixed_value ←↩↪→ ":false,"has_fixed_value":true,"id":"transient_state"}]}
Sample uom library write command (note that _event is a variable):
uom.relay.notifications.events[_event]={message_template={"outlet ",0," ←↩↪→ configured to be OFF at power-up"},parameters={{fixed_value=null, ←↩↪→ has_fixed_value=false,id="outlet"},{fixed_value=false,has_fixed_value=true, ←↩↪→ id="state"}},severity=6}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
118 CONTENTS
2.75.1 Message template
array relay/notifications/events/S/message_template/
Template for human-readable message generation
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Message template element elements.
Creating elements in this collection is not supported.
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/notifications/events/'+ ←↩↪→ _event+'/message_template/',auth=auth,headers=headers).json())
⇒['outlet ', 0, ' configured to be OFF at power-up']
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/notifications/events/:event/message_template/"
⇒["outlet ",0," configured to be ON at power-up"]
Browse more samples
2.75.1.1 Message template element
sum (variant) relay/notifications/events/S/message_template/N/
Element of human-readable message template
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 119
Message template elementStringParameter
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
check
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:
string String Fixed string
number Parameter Index of message parameter to insert event parameters[the value]
Sample curl read command (note that :event and :message_template_element_index are URLtemplate arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/relay/notifications/events/:event/message_template/: ←↩↪→ message_template_element_index/"
⇒0
Sample requests read command (note that _event and _message_template_element_index arevariables):
print(requests.get('http://192.168.0.100/restapi/relay/notifications/events/'+ ←↩↪→ _event+'/message_template/'+str(_message_template_element_index)+'/',auth= ←↩↪→ auth,headers=headers).json())
⇒' remains OFF at power-up'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
120 CONTENTS
2.75.2 Severity
sum (enumerated number) relay/notifications/events/S/severity/
Severity rating assigned to the event
SeverityEmergencyAlertCriticalErrorWarningNoticeInformationalDebug
Administrative userAdministratorRegular user
can_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 1 Emergency Treat the event as an emergency
constant 2 Alert Treat the event as an alertconstant 3 Critical Treat the event as criticalconstant 4 Error Treat the event as an errorconstant 5 Warning Treat the event as a warning
constant 6 Notice Treat the event as a noticeconstant 7 Informational Treat the event as informationalconstant 8 Debug Treat the event as debugging-related
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/relay/notifications/events/'+ ←↩↪→ _event+'/severity/',auth=auth,headers=headers).json())
DLI V222 Object Model Reference: 20210317T201932Z
2 Relay object 121
⇒6
Sample JS request read command (note that _event is a variable):
request.get({url:"relay/notifications/events/"+_event+"/severity/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒6
Browse more samples
2.75.3 Event parameters
array relay/notifications/events/S/parameters/
Additional data associated with the event
Event parameterid:Identifierhas_fixed_value:Fixed value flagfixed_value:Fixed value
Event parameters[element]:Event parameter
0..*
check Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Event parameter elements.
Creating elements in this collection is not supported.
Sample CLI read command (note that event is a variable):
uom get "relay/notifications/events/${event}/parameters"
⇒
DLI V222 Object Model Reference: 20210317T201932Z
122 CONTENTS
[{"fixed_value":null,"has_fixed_value":false,"id":"outlet"},{"fixed_value":true," ←↩↪→ has_fixed_value":true,"id":"state"}]
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.relay.notifications.events[_event].parameters))
⇒{{fixed_value=null,has_fixed_value=false,id="outlet"},{fixed_value=true, ←↩
↪→ has_fixed_value=true,id="state"}}
Browse more samples
See also Event parameters: Event parameter
3 Authentication server object
object auth/
Object representing the authentication server configuration
Users list[element]:User account
check
Administrative userAdministratorRegular user
can_read,can_write
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
Authentication server objectusers:Users listrealm:Realmcookie_timeout:Cookie timeoutnotifications:Notifications
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
users Users listrealm Realmcookie_timeout Cookie timeoutnotifications Notifications
Sample CLI read command:
uom get auth
⇒
...
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 123
Sample uom library write command:
uom.auth=<...>
Browse more samples
3.1 Users list
array auth/users/
List of user accounts
User accountname:Usernamepassword:Passwordis_allowed:User allowedis_admin:Administrative useroutlet_access:Outlet access levels
Administrative userAdministratorRegular user
can_delete
Users list[element]:User account
0..*
checkAdministrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array represents a value in persistent storage.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be suppliedmore than once).
This array contains User account elements.
Sample uom library write command:
uom.auth.users={{is_allowed=true,name="admin",outlet_access={true,true,true,true, ←↩↪→ true,true,true,true},password="Hf(5\\W:}'P"},{is_allowed=true,name="tom", ←↩↪→ outlet_access={false,true,false,false,true,false,false,false},password="h`b ←↩↪→ }EhuCw"},{is_allowed=false,name="dick",outlet_access={true,false,false,true ←↩↪→ ,false,true,false,false},password="a#\\I,q&c,"},{is_admin=false,is_allowed= ←↩↪→ true,name="harry",outlet_access={true,false,false,true,false,false,false, ←↩↪→ false},password="_J)X>41!8.a\"AD"}}
Sample uom library read command:
print(uom.dump(uom.auth.users))
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
124 CONTENTS
3.1.1 User account
object auth/users/N/
User account configuration
Outlet access levels[element]:Outlet access
Administrative userAdministratorRegular user
can_read,can_write
Outlets[element]:Outlet
check
descref__auth__users____is_adminreadonly
User accountname:Usernamepassword:Passwordis_allowed:User allowedis_admin:Administrative useroutlet_access:Outlet access levels
can_delete
Removing the object from its parent collection is denied if administrative user
This object contains the following items:
name Usernamepassword Password
is_allowed User allowedis_admin Administrative useroutlet_access Outlet access levels
Sample JS request write command (note that _user_account_index is a variable):
request.put({url:"auth/users/"+_user_account_index.toString()+"/",body:{"password ←↩↪→ ":",-*=&S^3m%!","is_admin":false,"name":"admin","is_allowed":true," ←↩↪→ outlet_access":[true,true,true,true,true,true,true,true]}});
Sample uom library read command (note that _user_account_index is a variable):
print(uom.dump(uom.auth.users[_user_account_index]))
⇒{is_admin=false,is_allowed=true,name="harry",outlet_access={true,false,true,false ←↩
↪→ ,true,true,true,false},password="<>[[Kowr[E"}
Browse more samples
See also User account: Username
See also User account: Password
See also User account: User allowed
See also User account: Administrative user
See also User account: Outlet access levels
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 125
3.2 User account: Username
string auth/users/N/name/
Username
Username
Administrative userAdministratorRegular user
can_read,can_write
Administrative userAdministratorRegular user
synchronize_condition
Users list[element]:User account
check
Password
synchronize_target
The value is subject to the following constraints: all of the following is true:
• the value matches ∧[a-zA-Z0-9]∗$
• name members of all values of users list are distinct
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Write operations must supply the current value of password if administrative user
Sample CLI write command (note that user_account_index is a variable):
uom set "auth/users/${user_account_index}/name" "\"admin\""
Sample requests read command (note that _user_account_index is a variable):
print(requests.get('http://192.168.0.100/restapi/auth/users/'+str( ←↩↪→ _user_account_index)+'/name/',auth=auth,headers=headers).json())
⇒'admin'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
126 CONTENTS
3.3 User account: Password
string auth/users/N/password/
Password
Password
synchronize_target
Administrative userAdministratorRegular user
can_read
Administrative userAdministratorRegular user
can_read,synchronize_condition
Hide user passwordsHideShow
can_read
The value is subject to the following constraints: the value matches ∧[ -∼]∗$Retrieving the value is denied if any of the following is true:
• not administrative user
• administrative user
• hide user passwords
Using the string as a field for indexing into the grandparent collection is denied
This string represents a value in persistent storage.
This string should be displayed in a secure manner.
Write operations must supply the current value of the value if administrative user
Sample JS request read command (note that _user_account_index is a variable):
request.get({url:"auth/users/"+_user_account_index.toString()+"/password/"}, ←↩↪→ function(error,response,body) {console.log(body)});
⇒"B%_`{jEGgMgyS^C"
Sample CLI read command (note that user_account_index is a variable):
uom get "auth/users/${user_account_index}/password"
⇒") $:$J_n"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 127
3.4 User account: User allowed
sum (boolean) auth/users/N/is_allowed/
Flag indicating whether user is allowed or denied
User allowedAllowedDenied
Administrative userAdministratorRegular user
can_read,can_write
Administrative userAdministratorRegular user
readonly
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum does not support direct modification if administrative user.
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Allowed The user is allowed to log in
constant false Denied The user is denied login
Sample requests read command (note that _user_account_index is a variable):
print(requests.get('http://192.168.0.100/restapi/auth/users/'+str( ←↩↪→ _user_account_index)+'/is_allowed/',auth=auth,headers=headers).json())
⇒True
Sample requests write command (note that _user_account_index is a variable):
requests.put('http://192.168.0.100/restapi/auth/users/'+str(_user_account_index) ←↩↪→ +'/is_allowed/',auth=auth,headers=headers,json=True)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
128 CONTENTS
3.5 User account: Administrative user
sum (boolean) auth/users/N/is_admin/
Flag indicating whether the user is an administrator
Administrative userAdministratorRegular user
synchronize_condition,can_delete,readonly,can_read
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum does not support direct modification.
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Administrator The user is an administratorconstant false Regular user The user is a regular user
Sample CLI read command (note that user_account_index is a variable):
uom get "auth/users/${user_account_index}/is_admin"
⇒false
Sample uom library read command (note that _user_account_index is a variable):
print(uom.dump(uom.auth.users[_user_account_index].is_admin))
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 129
3.6 User account: Outlet access levels
array auth/users/N/outlet_access/
Access levels per outlet
Outlet access levels[element]:Outlet access
Administrative userAdministratorRegular user
can_read,can_write
Administrative userAdministratorRegular user
readonly
Outlets[element]:Outlet
check
The value is subject to the following constraints: length of the value is equal to length of outlets
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array does not support direct modification if administrative user.
This array represents a value in persistent storage.
This array contains Outlet access elements.
Sample requests outlet access creation command (note that _user_account_index is a variable):
requests.post('http://192.168.0.100/restapi/auth/users/'+str(_user_account_index) ←↩↪→ +'/outlet_access/',auth=auth,headers=headers,json=True)
Sample CLI read command (note that user_account_index is a variable):
uom get "auth/users/${user_account_index}/outlet_access"
⇒[false,false,true,false,false,false,true,true]
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
130 CONTENTS
3.6.1 Outlet access
sum (boolean) auth/users/N/outlet_access/N/
Access level for outlet by index
Outlet accessFullNone
Administrative userAdministratorRegular user
can_read,can_write
Administrative userAdministratorRegular user
readonly
Outlets[element]:Outlet
check
The value is subject to the following constraints: outlets[index of the value]
Retrieving the value is denied if not administrative user
Changing 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 if administrative user.
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Full Outlet state can be manipulated by the user
constant false None Outlet state cannot be neither seen nor manipulatedby the user
Sample requests read command (note that _user_account_index and _outlet_access_index arevariables):
print(requests.get('http://192.168.0.100/restapi/auth/users/'+str( ←↩
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 131
↪→ _user_account_index)+'/outlet_access/'+str(_outlet_access_index)+'/',auth= ←↩↪→ auth,headers=headers).json())
⇒True
Sample uom library deletion command (note that _user_account_index and _outlet_access_indexare variables):
local composite=uom.copy(uom.auth.users[_user_account_index].outlet_access)uom.remove(composite,_outlet_access_index)uom.auth.users[_user_account_index].outlet_access=composite
Browse more samples
3.7 Realm
string auth/realm/
The realm to be announced in authentication responses
Realm Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample requests write command:
requests.put('http://192.168.0.100/restapi/auth/realm/',auth=auth,headers=headers ←↩↪→ ,json={})
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/auth/realm/"
⇒[]
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
132 CONTENTS
3.8 Cookie timeout
number auth/cookie_timeout/The amount of time for which a cookie is valid
Cookie timeout Administrative userAdministratorRegular user
can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample JS request write command:
request.put({url:"auth/cookie_timeout/",body:30000});
Sample uom library write command:
uom.auth.cookie_timeout=30000
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 133
3.9 Notifications
object auth/notifications/
Authentication-related notifications
Parameter kindsauth_login:Usernameauth_ip:IP addressauth_method:Methodauth_reason:Reasonauth_allowed:Authentication alloweduser_state:User state
check
Events[element]:Event
Administrative userAdministratorRegular usercan_read
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
Retrieving the value is denied if not administrative user
This object does not support direct modification.
This object contains the following items:
parameter_kinds Parameter kinds
events Events
Sample uom library read command:
print(uom.dump(uom.auth.notifications))
⇒<...>
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/auth/notifications/',auth=auth, ←↩↪→ headers=headers).json())
⇒<...>
Browse more samples
See also Notifications: Parameter kinds
DLI V222 Object Model Reference: 20210317T201932Z
134 CONTENTS
3.9.1 Events
map auth/notifications/events/
Event templates
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
Events[element]:Event
0..*
Administrative userAdministratorRegular user
can_read
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 Event 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/auth/notifications/events/"
⇒...
Sample uom library read command:
print(uom.dump(uom.auth.notifications.events))
⇒<...>
Browse more samples
See also Events: Event
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 135
3.10 Notifications: Parameter kinds
object auth/notifications/parameter_kinds/
Kinds of event parameters
This object does not correspond to an actual resource.
This object contains the following items:
auth_login Username
auth_ip IP address
auth_method Methodauth_reason Reasonauth_allowed Authentication alloweduser_state User state
3.10.1 Username
string auth/notifications/parameter_kinds/auth_login/
The name of the user
3.10.2 IP address
string auth/notifications/parameter_kinds/auth_ip/
The IP address of the user
The value is subject to the following constraints: the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
DLI V222 Object Model Reference: 20210317T201932Z
136 CONTENTS
3.10.3 Method
string auth/notifications/parameter_kinds/auth_method/
The authentication method
3.10.4 Reason
string auth/notifications/parameter_kinds/auth_reason/
The reason for authentication decision
3.10.5 Authentication allowed
sum (boolean) auth/notifications/parameter_kinds/auth_allowed/
Authentication decision result
This sum can assume the following values:
constant true Allowed The user is allowed to log in
constant false Denied The user is denied to log in
3.10.6 User state
sum (variant) auth/notifications/parameter_kinds/user_state/
The state of the user
This sum can assume the following values:
constant true Existing The user exists
constant false Deleted The user has been deletedconstant "new" New The user has been created
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 137
3.11 Event parameters: Event parameter
object auth/notifications/events/S/parameters/N/
Properties of a parameter associated with the event
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
id Identifierhas_fixed_value Fixed value flag
fixed_value Fixed value
Sample curl read command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/auth/notifications/events/:event/parameters/:event_parameter_index ←↩↪→ /"
⇒{"fixed_value":null,"has_fixed_value":false,"id":"auth_ip"}
Sample CLI write command (note that event and event_parameter_index are variables):
uom set "auth/notifications/events/${event}/parameters/${event_parameter_index}" ←↩↪→ "{\"fixed_value\":null,\"has_fixed_value\":false,\"id\":\"auth_method\"}"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
138 CONTENTS
3.11.1 Identifier
string auth/notifications/events/S/parameters/N/id/
Parameter identifier
Identifier
Parameter kindsauth_login:Usernameauth_ip:IP addressauth_method:Methodauth_reason:Reasonauth_allowed:Authentication alloweduser_state:User state
check
Administrative userAdministratorRegular user
can_read
The value is subject to the following constraints: parameter kinds[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 _event and _event_parameter_index are variables):
print(uom.dump(uom.auth.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].id))
⇒"user_state"
Sample JS request read command (note that _event and _event_parameter_index are variables):
request.get({url:"auth/notifications/events/"+_event+"/parameters/"+ ←↩↪→ _event_parameter_index.toString()+"/id/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"auth_login"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 139
3.11.2 Fixed value flag
sum (boolean) auth/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
Fixed value flagFixedVariable
Administrative userAdministratorRegular user
can_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 Fixed The value is fixedconstant false Variable The value is variable
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.auth.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].has_fixed_value))
⇒false
Sample JS request read command (note that _event and _event_parameter_index are variables):
request.get({url:"auth/notifications/events/"+_event+"/parameters/"+ ←↩↪→ _event_parameter_index.toString()+"/has_fixed_value/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
140 CONTENTS
3.11.3 Fixed value
sum (variant) auth/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
Fixed valueNullTrueFalseStringNumber
Administrative userAdministratorRegular user
can_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 null Null Nullconstant true True Trueconstant false False Falsestring String This string
number Number This number
Sample curl read command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/auth/notifications/events/:event/parameters/:event_parameter_index/ ←↩↪→ fixed_value/"
⇒
null
Sample requests read command (note that _event and _event_parameter_index are variables):
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 141
print(requests.get('http://192.168.0.100/restapi/auth/notifications/events/'+ ←↩↪→ _event+'/parameters/'+str(_event_parameter_index)+'/fixed_value/',auth=auth ←↩↪→ ,headers=headers).json())
⇒None
Browse more samples
3.12 Events: Event
object auth/notifications/events/S/
Event template
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
can_readcheck
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
message_template Message template
severity Severity
parameters Event parameters
Sample requests write command (note that _event is a variable):
requests.put('http://192.168.0.100/restapi/auth/notifications/events/'+_event ←↩↪→ +'/',auth=auth,headers=headers,json={'severity': 7, 'message_template': [0, ←↩↪→ '@', 1, ' session closed'], 'parameters': [{'fixed_value': None, ' ←↩↪→ has_fixed_value': False, 'id': 'auth_login'}, {'fixed_value': None, ' ←↩↪→ has_fixed_value': False, 'id': 'auth_ip'}]})
Sample JS request write command (note that _event is a variable):
request.put({url:"auth/notifications/events/"+_event+"/",body:{"severity":6," ←↩↪→ message_template":["modified user ",0],"parameters":[{"fixed_value":null," ←↩↪→ has_fixed_value":false,"id":"auth_login"},{"fixed_value":true," ←↩↪→ has_fixed_value":true,"id":"user_state"}]}});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
142 CONTENTS
3.12.1 Message template
array auth/notifications/events/S/message_template/
Template for human-readable message generation
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Message template element elements.
Creating elements in this collection is not supported.
Sample CLI read command (note that event is a variable):
uom get "auth/notifications/events/${event}/message_template"
⇒["created user ",0]
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/auth/notifications/events/:event/message_template/"
⇒["deleted user ",0]
Browse more samples
3.12.1.1 Message template element
sum (variant) auth/notifications/events/S/message_template/N/
Element of human-readable message template
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 143
Message template elementStringParameter
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
check
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:
string String Fixed string
number Parameter Index of message parameter to insert event parameters[the value]
Sample CLI read command (note that event and message_template_element_index are variables):
uom get "auth/notifications/events/${event}/message_template/${ ←↩↪→ message_template_element_index}"
⇒"protection violation attempt: "
Sample JS request read command (note that _event and _message_template_element_index arevariables):
request.get({url:"auth/notifications/events/"+_event+"/message_template/"+ ←↩↪→ _message_template_element_index.toString()+"/"},function(error,response, ←↩↪→ body) {console.log(body)});
⇒2
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
144 CONTENTS
3.12.2 Severity
sum (enumerated number) auth/notifications/events/S/severity/
Severity rating assigned to the event
SeverityEmergencyAlertCriticalErrorWarningNoticeInformationalDebug
Administrative userAdministratorRegular user
can_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 1 Emergency Treat the event as an emergency
constant 2 Alert Treat the event as an alertconstant 3 Critical Treat the event as criticalconstant 4 Error Treat the event as an errorconstant 5 Warning Treat the event as a warning
constant 6 Notice Treat the event as a noticeconstant 7 Informational Treat the event as informationalconstant 8 Debug Treat the event as debugging-related
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.auth.notifications.events[_event].severity))
DLI V222 Object Model Reference: 20210317T201932Z
3 Authentication server object 145
⇒6
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/auth/notifications/events/:event/severity/"
⇒7
Browse more samples
3.12.3 Event parameters
array auth/notifications/events/S/parameters/
Additional data associated with the event
Event parameterid:Identifierhas_fixed_value:Fixed value flagfixed_value:Fixed value
Event parameters[element]:Event parameter
0..*
check Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Event parameter elements.
Creating elements in this collection is not supported.
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.auth.notifications.events[_event].parameters))
⇒
DLI V222 Object Model Reference: 20210317T201932Z
146 CONTENTS
{{fixed_value=null,has_fixed_value=false,id="auth_login"},{fixed_value=null, ←↩↪→ has_fixed_value=false,id="auth_ip"}}
Sample JS request read command (note that _event is a variable):
request.get({url:"auth/notifications/events/"+_event+"/parameters/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒[{"fixed_value":null,"has_fixed_value":false,"id":"auth_login"},{"fixed_value": ←↩
↪→ false,"has_fixed_value":true,"id":"user_state"}]
Browse more samples
See also Event parameters: Event parameter
4 Configuration server object
object config/
Object representing configuration server
Links list[element]:Link
Administrative userAdministratorRegular user
can_read,can_writePlots list
[element]:Plot
can_read,can_writeMeters list
[element]:Meter configuration
can_read,can_writeRelated contacts[element]:Contact
can_read,can_write
HTTP ports[element]:Port binding
can_read,can_write
Protect network settingsProtectedNot protected
can_write
HTTPS ports[element]:Port binding
can_read,can_write
can_write
HTTPS certificate settingsbits:Bitsdistinguished_name:Distinguished namestring_mask:String maskdomains:Domain names override, if anyaddresses:Addresses override, if anyautomatic_renewal:Automatic renewalrenewal_method:Certificate renewal methodrenewal_data:Datacsr:HTTPS certificate signing request, if it can be generatedcert:HTTPS certificate chainkey:HTTPS certificate keyrenew_cert:Renew certificategenerate_key:Generate keyknown_dn_oids:Known DN OIDsknown_renewal_methods:Renewal methods
can_read
Certificate collection[element]:Certificate
can_read,can_write
can_write
Certificate revocation list collection[element]:Certificate revocation list
can_read,can_write
can_write
SSH authorized keys[element]:SSH authorized key
can_read,can_write
can_write
NTP peers[element]:NTP peer
can_read,can_write
can_write
Allowed REST-like API client origins[element]:Allowed REST-like API client origin
can_read,can_write
can_write
Allowed CoAP over WebSockets client origins[element]:Allowed CoAP over WebSockets client origin
can_read,can_write
can_write
Known quantities[element]:Quantity
check
Known timezones[element]:Timezone
can_read
check
Known protection bits[element]:Protection bit
can_read
Relay ports[element]:Relay port
can_read
Configuration server objectlinks:Links listplots:Plots listmeters:Meters listcontact:Primary unit contactcontacts:Related contactslocation:Unit locationoid:Model OIDversion:Version numberhardware_id:Hardware IDserial:Serial numberoutlet_label:Outlet labelbrand_company_name:Brand company namebrand_name:Brand namebrand_url:Brand URLbrand_manual_url:Brand manual URLbrand_faq_url:Brand FAQ URLbrand_product_info_url:Brand product information URLsupport_email:Support emailregister_url:Registration URLsupport_url:Support URLupdate_url:Update URLcustom_brand_company_name:Custom brand company name, if anycustom_brand_name:Custom brand name, if anycustom_brand_url:Custom brand URL, if anycustom_brand_logo:Custom brand logo URL, if anycustom_brand_logo_width:Custom brand logo width, if anycustom_brand_logo_height:Custom brand logo height, if anycustom_support_email:Custom support email, if anycustom_register_url:Custom registration URL, if anycustom_support_url:Custom support URL, if anycustom_update_url:Custom update URL, if anycustom_help_url:Custom help URL, if anycustomization_status:Customization statusregistration_status:Registration statusrefresh_enabled:Enable page refreshrefresh_delay_minutes:Page refresh delayimage_format:Preferred image formathostname:Unit hostnametimezone:Time zonehttp_ports:HTTP portshttps_ports:HTTPS portshttps_cert:HTTPS certificate settingscertificates:Certificate collectioncrls:Certificate revocation list collectionssh_enabled:SSH enabledssh_port:SSH port numberssh_authorized_keys:SSH authorized keysntp_server_enabled:NTP server enabledntp_peers:NTP peerssyslog_minimal_severity:Syslog threshold severitysyslog_ip_address:Syslog server address, if anyallow_jsonrpc:Allow JSON-RPCallow_jsonrpc_nonadmin:Allow non-administrative users to perform JSON-RPC requestsallow_restapi:Allow REST-like APIallow_restapi_nonadmin:Allow non-administrative users to access REST-like APIallow_restapi_origins:Allowed REST-like API client originsallow_coapws:Allow CoAP over WebSocketsallow_coapws_nonadmin:Allow non-administrative users to access CoAP over WebSocketsallow_coapws_origins:Allowed CoAP over WebSockets client originsrelax_nonhtml_methods:Relax non-HTML method CSRF checksrelax_nonhtml_content_types:Relax non-HTML content type CSRF checksallow_plaintext_logins:Allow plaintext loginsallow_modifying_get:Allow state-changing GET requestsname_always_visible:Relay name visibilityhide_passwords:Hide user passwordshide_wifi_key:Hide WiFi keylockout_delay_minutes:Security lockout durationprotect_firmware:Protect firmwareprotect_admin:Protect admin loginprotect_network:Protect network settingsprotect_private_config:Protect private settingsprotect_restore:Protect from restoreprotect_maintenance:Protect from maintenanceprotect_notification:Protect notification settingsupgrade_notify_beep:Beep on upgradeupgrade_notify_blink:Blink on upgradeknown_quantities:Known quantitiesknown_timezones:Known timezonesknown_protection_bits:Known protection bitsrelay_ports:Relay ports
This object contains the following items:
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 147
links Links listplots Plots list
meters Meters listcontact Primary unit contact
contacts Related contactslocation Unit locationoid Model OIDversion Version numberhardware_id Hardware IDserial Serial numberoutlet_label Outlet labelbrand_company_name Brand company name
brand_name Brand namebrand_url Brand URLbrand_manual_url Brand manual URLbrand_faq_url Brand FAQ URL
brand_product_info_url Brand product information URL
support_email Support email
register_url Registration URL
support_url Support URL
update_url Update URL
custom_brand_company_name Custom brand company name, if any
custom_brand_name Custom brand name, if any
custom_brand_url Custom brand URL, if any
custom_brand_logo Custom brand logo URL, if any
custom_brand_logo_width Custom brand logo width, if any
custom_brand_logo_height Custom brand logo height, if any
custom_support_email Custom support email, if any
custom_register_url Custom registration URL, if any
custom_support_url Custom support URL, if any
custom_update_url Custom update URL, if any
custom_help_url Custom help URL, if any
customization_status Customization statusregistration_status Registration status
refresh_enabled Enable page refresh
refresh_delay_minutes Page refresh delay
image_format Preferred image format
hostname Unit hostnametimezone Time zonehttp_ports HTTP ports
https_ports HTTPS ports
https_cert HTTPS certificate settings
certificates Certificate collectioncrls Certificate revocation list collectionssh_enabled SSH enabledssh_port SSH port number
ssh_authorized_keys SSH authorized keys
ntp_server_enabled NTP server enabled
ntp_peers NTP peers
syslog_minimal_severity Syslog threshold severity
DLI V222 Object Model Reference: 20210317T201932Z
148 CONTENTS
syslog_ip_address Syslog server address, if any
allow_jsonrpc Allow JSON-RPC
allow_jsonrpc_nonadmin Allow non-administrative users to perform JSON-RPC requests
allow_restapi Allow REST-like API
allow_restapi_nonadmin Allow non-administrative users to access REST-like API
allow_restapi_origins Allowed REST-like API client origins
allow_coapws Allow CoAP over WebSockets
allow_coapws_nonadmin Allow non-administrative users to access CoAP over WebSockets
allow_coapws_origins Allowed CoAP over WebSockets client origins
relax_nonhtml_methods Relax non-HTML method CSRF checksrelax_nonhtml_content_types Relax non-HTML content type CSRF checks
allow_plaintext_logins Allow plaintext logins
allow_modifying_get Allow state-changing GET requests
name_always_visible Relay name visibility
hide_passwords Hide user passwords
hide_wifi_key Hide WiFi key
lockout_delay_minutes Security lockout duration
protect_firmware Protect firmware
protect_admin Protect admin login
protect_network Protect network settings
protect_private_config Protect private settings
protect_restore Protect from restore
protect_maintenance Protect from maintenance
protect_notification Protect notification settings
upgrade_notify_beep Beep on upgrade
upgrade_notify_blink Blink on upgrade
known_quantities Known quantities
known_timezones Known timezonesknown_protection_bits Known protection bits
relay_ports Relay ports
Sample CLI read command:
uom get config
⇒...
Sample CLI write command:
uom set config ...
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 149
4.1 Links list
array config/links/
List of user-defined links to display in the web UI
Linkhref:URIdescription:Description
Administrative userAdministratorRegular user
can_readLinks list
[element]:Link
0..*
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array represents a value in persistent storage.
This array contains Link elements.
Sample JS request link creation command:
request.post({url:"config/links/",body:{"description":"test 5","href":"test_url7 ←↩↪→ "}});
Sample JS request read command:
request.get({url:"config/links/"},function(error,response,body) {console.log(body ←↩↪→ )});
⇒[{"description":"test 5","href":"test_url7"},{"description":"test 3","href":" ←↩
↪→ test_url5"}]
Browse more samples
See also Links list: Link
DLI V222 Object Model Reference: 20210317T201932Z
150 CONTENTS
4.2 Links list: Link
object config/links/N/
User-defined link
Linkhref:URIdescription:Description
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This object represents a value in persistent storage.
This object contains the following items:
href URIdescription Description
Sample JS request write command (note that _link_index is a variable):
request.put({url:"config/links/"+_link_index.toString()+"/",body:{"description":" ←↩↪→ test 5","href":"test_url7"}});
Sample uom library write command (note that _link_index is a variable):
uom.config.links[_link_index]={description="test 3",href="test_url5"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 151
4.2.1 URI
string config/links/N/href/
The target URI of the link
URI Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample CLI write command (note that link_index is a variable):
uom set "config/links/${link_index}/href" "\"test_url5\""
Sample JS request write command (note that _link_index is a variable):
request.put({url:"config/links/"+_link_index.toString()+"/href/",body:"test_url7 ←↩↪→ "});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
152 CONTENTS
4.2.2 Description
string config/links/N/description/
The textual representation of the link
Description Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample uom library write command (note that _link_index is a variable):
uom.config.links[_link_index].description="test 5"
Sample JS request read command (note that _link_index is a variable):
request.get({url:"config/links/"+_link_index.toString()+"/description/"},function ←↩↪→ (error,response,body) {console.log(body)});
⇒"test 3"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 153
4.3 Plots list
array config/plots/
List of plots to display in the web UI
Plottitle:Titledisplay:Displaywidth:Widthheight:Heightx1:X1 axis settingsx2:X2 axis settingsy1:Y1 axis settingsy2:Y2 axis settingsdata:Plot lines
Plots list[element]:Plot
0..*
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array represents a value in persistent storage.
This array contains Plot elements.
Sample JS request plot creation command:
request.post({url:"config/plots/",body:{"x2":{"min":null,"softmax":null,"max": ←↩↪→ null,"tics":null,"mtics":null,"softmin":null},"y2":{"min":null,"softmax": ←↩↪→ null,"max":null,"tics":null,"mtics":null,"softmin":null},"data":[{"ds":" ←↩↪→ environment.illuminance","style":{"type":"solid","style":"lines","width ←↩↪→ ":1,"color":"FF0000","axes":"x1y1","marker":"plus","size":0},"title":" ←↩↪→ Illuminance"}],"width":640,"title":"Illuminance","display":false,"y1":{"min ←↩↪→ ":0,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null},"x1 ←↩↪→ ":{"min":null,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin": ←↩↪→ null},"height":480}});
Sample requests read command:
DLI V222 Object Model Reference: 20210317T201932Z
154 CONTENTS
print(requests.get('http://192.168.0.100/restapi/config/plots/',auth=auth,headers ←↩↪→ =headers).json())
⇒<...>
Browse more samples
4.3.1 Plot
object config/plots/N/
Configuration of plot for measured values
X1 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
Administrative userAdministratorRegular user
can_read,can_write
X2 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
can_read,can_write
Y1 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
can_read,can_write
Y2 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
can_read,can_write
Plot lines[element]:Plot line configuration
Plottitle:Titledisplay:Displaywidth:Widthheight:Heightx1:X1 axis settingsx2:X2 axis settingsy1:Y1 axis settingsy2:Y2 axis settingsdata:Plot lines
This object contains the following items:
title Titledisplay Display
width Widthheight Height
x1 X1 axis settings
x2 X2 axis settings
y1 Y1 axis settings
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 155
y2 Y2 axis settings
data Plot lines
Sample curl write command (note that :plot_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 "{\"x2\":{\"min\":null,\" ←↩↪→ softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null ←↩↪→ },\"y2\":{\"min\":0,\"softmax\":1,\"max\":null,\"tics\":null,\"mtics\":null ←↩↪→ ,\"softmin\":null},\"data\":[{\"ds\":\"buses.1.voltage\",\"style\":{\"type ←↩↪→ \":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"FF0000\",\"axes ←↩↪→ \":\"x1y1\",\"marker\":\"plus\",\"size\":0},\"title\":\"Bus B voltage ←↩↪→ \"},{\"ds\":\"buses.1.current\",\"style\":{\"type\":\"solid\",\"style\":\" ←↩↪→ lines\",\"width\":1,\"color\":\"0000FF\",\"axes\":\"x1y2\",\"marker\":\" ←↩↪→ plus\",\"size\":0},\"title\":\"Bus B current\"}],\"width\":640,\"title\":\" ←↩↪→ Bus B status\",\"display\":true,\"y1\":{\"min\":0,\"softmax\":110,\"max\": ←↩↪→ null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"x1\":{\"min\":null,\" ←↩↪→ softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null ←↩↪→ },\"height\":480}" "http://192.168.0.100/restapi/config/plots/:plot_index/"
Sample JS request deletion command (note that _plot_index is a variable):
request.delete({url:"config/plots/"+_plot_index.toString()+"/"});
Browse more samples
See also Plot: Title
See also Plot: Display
See also Plot: Width
See also Plot: Height
See also Plot: X1 axis settings
See also Plot: X2 axis settings
See also Plot: Y1 axis settings
See also Plot: Y2 axis settings
See also Plot: Plot lines
DLI V222 Object Model Reference: 20210317T201932Z
156 CONTENTS
4.4 Plot: Title
string config/plots/N/title/
The title of the plot
Title Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample curl write command (note that :plot_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 "\"Bus B status\"" "http ←↩↪→ ://192.168.0.100/restapi/config/plots/:plot_index/title/"
Sample JS request write command (note that _plot_index is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/title/",body:"Relay ←↩↪→ voltage"});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 157
4.5 Plot: Display
sum (boolean) config/plots/N/display/
Indicates whether the plot should be displayed
DisplayShownHidden
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Shown The plot is shown
constant false Hidden The plot is hidden
Sample CLI write command (note that plot_index is a variable):
uom set "config/plots/${plot_index}/display" "true"
Sample requests read command (note that _plot_index is a variable):
print(requests.get('http://192.168.0.100/restapi/config/plots/'+str(_plot_index) ←↩↪→ +'/display/',auth=auth,headers=headers).json())
⇒True
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
158 CONTENTS
4.6 Plot: Width
number config/plots/N/width/
The width of the plot
Width Administrative userAdministratorRegular user
can_read,can_write
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample curl write command (note that :plot_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 "640" "http ←↩↪→ ://192.168.0.100/restapi/config/plots/:plot_index/width/"
Sample JS request write command (note that _plot_index is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/width/",body:640});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 159
4.7 Plot: Height
number config/plots/N/height/
The height of the plot
Height Administrative userAdministratorRegular user
can_read,can_write
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample uom library write command (note that _plot_index is a variable):
uom.config.plots[_plot_index].height=480
Sample requests write command (note that _plot_index is a variable):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/ ←↩↪→ height/',auth=auth,headers=headers,json=480)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
160 CONTENTS
4.8 Plot: X1 axis settings
object config/plots/N/x1/
Configuration for X1 axis
X1 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This object is composite, i.e. is modified as a whole.
This object represents a value in persistent storage.
This object contains the following items:
min Minimum, if any
max Maximum, if any
softmin Soft minimum, if any
softmax Soft maximum, if any
tics Major tick interval, if any
mtics Minor ticks per major tick, if any
Sample requests read command (note that _plot_index is a variable):
print(requests.get('http://192.168.0.100/restapi/config/plots/'+str(_plot_index) ←↩↪→ +'/x1/',auth=auth,headers=headers).json())
⇒{'min': None, 'softmax': None, 'max': None, 'tics': None, 'mtics': None, 'softmin ←↩
↪→ ': None}
Sample JS request read command (note that _plot_index is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/x1/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒{"min":null,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 161
4.8.1 Minimum, if any
sum (optional number) config/plots/N/x1/min/
Minimum value to display on the axis, if any
Minimum, if anyAutomaticMinimum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The maximum value is derived from data and the softmaximum
number Minimum Minimum value to display on the axis
Sample curl read command (note that :plot_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/plots/:plot_index/x1/min/"
⇒null
Sample JS request read command (note that _plot_index is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/x1/min/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
162 CONTENTS
4.8.2 Maximum, if any
sum (optional number) config/plots/N/x1/max/
Maximum value to display on the axis, if any
Maximum, if anyAutomaticMaximum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The minimum value is derived from data and the softminimum
number Maximum Maximum value to display on the axis
Sample curl write command (note that :plot_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 "null" "http ←↩↪→ ://192.168.0.100/restapi/config/plots/:plot_index/x1/max/"
Sample requests write command (note that _plot_index is a variable):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/x1/ ←↩↪→ max/',auth=auth,headers=headers,json=None)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 163
4.8.3 Soft minimum, if any
sum (optional number) config/plots/N/x1/softmin/
Minimum value to display on the axis unless values exist below it, if any
Soft minimum, if anyNoneSoft minimum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None No soft maximum definednumber Soft minimum Minimum value to display on the axis unless values
exist below it
Sample uom library write command (note that _plot_index is a variable):
uom.config.plots[_plot_index].x1.softmin=null
Sample curl write command (note that :plot_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 "null" "http ←↩↪→ ://192.168.0.100/restapi/config/plots/:plot_index/x1/softmin/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
164 CONTENTS
4.8.4 Soft maximum, if any
sum (optional number) config/plots/N/x1/softmax/
Maximum value to display on the axis unless values exist above it, if any
Soft maximum, if anyNoneSoft maximum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None No soft minimum definednumber Soft maximum Maximum value to display on the axis unless values
exist above it
Sample CLI write command (note that plot_index is a variable):
uom set "config/plots/${plot_index}/x1/softmax" "null"
Sample requests write command (note that _plot_index is a variable):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/x1/ ←↩↪→ softmax/',auth=auth,headers=headers,json=None)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 165
4.8.5 Major tick interval, if any
sum (optional number) config/plots/N/x1/tics/
The interval, in value units, between major ticks of the axis, if any
Major tick interval, if anyAutomaticMajor tick interval
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The tick interval is derived from data and sizenumber Major tick interval The interval, in value units, between major ticks of the
axis
Sample curl write command (note that :plot_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 "null" "http ←↩↪→ ://192.168.0.100/restapi/config/plots/:plot_index/x1/tics/"
Sample CLI write command (note that plot_index is a variable):
uom set "config/plots/${plot_index}/x1/tics" "null"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
166 CONTENTS
4.8.6 Minor ticks per major tick, if any
sum (optional number) config/plots/N/x1/mtics/
The number of minor ticks between two major ticks, if any
Minor ticks per major tick, if anyNoneMinor ticks per major tick
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None There are no minor ticksnumber Minor ticks per major tick The number of minor ticks be-
tween two major ticksall of the following is true:
• the value is an integer
• the value is greater orequal to 0
Sample CLI write command (note that plot_index is a variable):
uom set "config/plots/${plot_index}/x1/mtics" "null"
Sample curl write command (note that :plot_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 "null" "http ←↩↪→ ://192.168.0.100/restapi/config/plots/:plot_index/x1/mtics/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 167
4.9 Plot: X2 axis settings
object config/plots/N/x2/
Configuration for X2 axis
X2 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This object is composite, i.e. is modified as a whole.
This object represents a value in persistent storage.
This object contains the following items:
min Minimum, if any
max Maximum, if any
softmin Soft minimum, if any
softmax Soft maximum, if any
tics Major tick interval, if any
mtics Minor ticks per major tick, if any
Sample requests read command (note that _plot_index is a variable):
print(requests.get('http://192.168.0.100/restapi/config/plots/'+str(_plot_index) ←↩↪→ +'/x2/',auth=auth,headers=headers).json())
⇒{'min': None, 'softmax': None, 'max': None, 'tics': None, 'mtics': None, 'softmin ←↩
↪→ ': None}
Sample JS request read command (note that _plot_index is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/x2/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒{"min":null,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
168 CONTENTS
4.9.1 Minimum, if any
sum (optional number) config/plots/N/x2/min/
Minimum value to display on the axis, if any
Minimum, if anyAutomaticMinimum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The maximum value is derived from data and the softmaximum
number Minimum Minimum value to display on the axis
Sample CLI write command (note that plot_index is a variable):
uom set "config/plots/${plot_index}/x2/min" "null"
Sample curl read command (note that :plot_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/plots/:plot_index/x2/min/"
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 169
4.9.2 Maximum, if any
sum (optional number) config/plots/N/x2/max/
Maximum value to display on the axis, if any
Maximum, if anyAutomaticMaximum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The minimum value is derived from data and the softminimum
number Maximum Maximum value to display on the axis
Sample uom library read command (note that _plot_index is a variable):
print(uom.dump(uom.config.plots[_plot_index].x2.max))
⇒null
Sample JS request write command (note that _plot_index is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/x2/max/",body:null});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
170 CONTENTS
4.9.3 Soft minimum, if any
sum (optional number) config/plots/N/x2/softmin/
Minimum value to display on the axis unless values exist below it, if any
Soft minimum, if anyNoneSoft minimum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None No soft maximum definednumber Soft minimum Minimum value to display on the axis unless values
exist below it
Sample curl write command (note that :plot_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 "null" "http ←↩↪→ ://192.168.0.100/restapi/config/plots/:plot_index/x2/softmin/"
Sample CLI write command (note that plot_index is a variable):
uom set "config/plots/${plot_index}/x2/softmin" "null"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 171
4.9.4 Soft maximum, if any
sum (optional number) config/plots/N/x2/softmax/
Maximum value to display on the axis unless values exist above it, if any
Soft maximum, if anyNoneSoft maximum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None No soft minimum definednumber Soft maximum Maximum value to display on the axis unless values
exist above it
Sample uom library write command (note that _plot_index is a variable):
uom.config.plots[_plot_index].x2.softmax=null
Sample uom library read command (note that _plot_index is a variable):
print(uom.dump(uom.config.plots[_plot_index].x2.softmax))
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
172 CONTENTS
4.9.5 Major tick interval, if any
sum (optional number) config/plots/N/x2/tics/
The interval, in value units, between major ticks of the axis, if any
Major tick interval, if anyAutomaticMajor tick interval
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The tick interval is derived from data and sizenumber Major tick interval The interval, in value units, between major ticks of the
axis
Sample requests read command (note that _plot_index is a variable):
print(requests.get('http://192.168.0.100/restapi/config/plots/'+str(_plot_index) ←↩↪→ +'/x2/tics/',auth=auth,headers=headers).json())
⇒None
Sample uom library read command (note that _plot_index is a variable):
print(uom.dump(uom.config.plots[_plot_index].x2.tics))
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 173
4.9.6 Minor ticks per major tick, if any
sum (optional number) config/plots/N/x2/mtics/
The number of minor ticks between two major ticks, if any
Minor ticks per major tick, if anyNoneMinor ticks per major tick
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None There are no minor ticksnumber Minor ticks per major tick The number of minor ticks be-
tween two major ticksall of the following is true:
• the value is an integer
• the value is greater orequal to 0
Sample uom library write command (note that _plot_index is a variable):
uom.config.plots[_plot_index].x2.mtics=null
Sample JS request write command (note that _plot_index is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/x2/mtics/",body:null});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
174 CONTENTS
4.10 Plot: Y1 axis settings
object config/plots/N/y1/
Configuration for Y1 axis
Y1 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This object is composite, i.e. is modified as a whole.
This object represents a value in persistent storage.
This object contains the following items:
min Minimum, if any
max Maximum, if any
softmin Soft minimum, if any
softmax Soft maximum, if any
tics Major tick interval, if any
mtics Minor ticks per major tick, if any
Sample CLI read command (note that plot_index is a variable):
uom get "config/plots/${plot_index}/y1"
⇒{"min":0,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null}
Sample requests write command (note that _plot_index is a variable):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/y1 ←↩↪→ /',auth=auth,headers=headers,json={'min': None, 'softmax': None, 'max': ←↩↪→ None, 'tics': None, 'mtics': None, 'softmin': None})
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 175
4.10.1 Minimum, if any
sum (optional number) config/plots/N/y1/min/
Minimum value to display on the axis, if any
Minimum, if anyAutomaticMinimum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The maximum value is derived from data and the softmaximum
number Minimum Minimum value to display on the axis
Sample JS request read command (note that _plot_index is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/y1/min/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒0
Sample requests read command (note that _plot_index is a variable):
print(requests.get('http://192.168.0.100/restapi/config/plots/'+str(_plot_index) ←↩↪→ +'/y1/min/',auth=auth,headers=headers).json())
⇒None
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
176 CONTENTS
4.10.2 Maximum, if any
sum (optional number) config/plots/N/y1/max/
Maximum value to display on the axis, if any
Maximum, if anyAutomaticMaximum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The minimum value is derived from data and the softminimum
number Maximum Maximum value to display on the axis
Sample uom library write command (note that _plot_index is a variable):
uom.config.plots[_plot_index].y1.max=null
Sample CLI write command (note that plot_index is a variable):
uom set "config/plots/${plot_index}/y1/max" "null"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 177
4.10.3 Soft minimum, if any
sum (optional number) config/plots/N/y1/softmin/
Minimum value to display on the axis unless values exist below it, if any
Soft minimum, if anyNoneSoft minimum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None No soft maximum definednumber Soft minimum Minimum value to display on the axis unless values
exist below it
Sample JS request write command (note that _plot_index is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/y1/softmin/",body:null ←↩↪→ });
Sample uom library write command (note that _plot_index is a variable):
uom.config.plots[_plot_index].y1.softmin=null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
178 CONTENTS
4.10.4 Soft maximum, if any
sum (optional number) config/plots/N/y1/softmax/
Maximum value to display on the axis unless values exist above it, if any
Soft maximum, if anyNoneSoft maximum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None No soft minimum definednumber Soft maximum Maximum value to display on the axis unless values
exist above it
Sample JS request write command (note that _plot_index is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/y1/softmax/",body:null ←↩↪→ });
Sample JS request read command (note that _plot_index is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/y1/softmax/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 179
4.10.5 Major tick interval, if any
sum (optional number) config/plots/N/y1/tics/
The interval, in value units, between major ticks of the axis, if any
Major tick interval, if anyAutomaticMajor tick interval
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The tick interval is derived from data and sizenumber Major tick interval The interval, in value units, between major ticks of the
axis
Sample requests write command (note that _plot_index is a variable):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/y1/ ←↩↪→ tics/',auth=auth,headers=headers,json=None)
Sample JS request write command (note that _plot_index is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/y1/tics/",body:null});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
180 CONTENTS
4.10.6 Minor ticks per major tick, if any
sum (optional number) config/plots/N/y1/mtics/
The number of minor ticks between two major ticks, if any
Minor ticks per major tick, if anyNoneMinor ticks per major tick
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None There are no minor ticksnumber Minor ticks per major tick The number of minor ticks be-
tween two major ticksall of the following is true:
• the value is an integer
• the value is greater orequal to 0
Sample CLI read command (note that plot_index is a variable):
uom get "config/plots/${plot_index}/y1/mtics"
⇒null
Sample curl read command (note that :plot_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/plots/:plot_index/y1/mtics/"
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 181
4.11 Plot: Y2 axis settings
object config/plots/N/y2/
Configuration for Y2 axis
Y2 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This object is composite, i.e. is modified as a whole.
This object represents a value in persistent storage.
This object contains the following items:
min Minimum, if any
max Maximum, if any
softmin Soft minimum, if any
softmax Soft maximum, if any
tics Major tick interval, if any
mtics Minor ticks per major tick, if any
Sample uom library read command (note that _plot_index is a variable):
print(uom.dump(uom.config.plots[_plot_index].y2))
⇒{max=null,min=0,mtics=null,softmax=1,softmin=null,tics=null}
Sample CLI write command (note that plot_index is a variable):
uom set "config/plots/${plot_index}/y2" "{\"min\":null,\"softmax\":null,\"max\": ←↩↪→ null,\"tics\":null,\"mtics\":null,\"softmin\":null}"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
182 CONTENTS
4.11.1 Minimum, if any
sum (optional number) config/plots/N/y2/min/
Minimum value to display on the axis, if any
Minimum, if anyAutomaticMinimum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The maximum value is derived from data and the softmaximum
number Minimum Minimum value to display on the axis
Sample JS request write command (note that _plot_index is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/y2/min/",body:null});
Sample requests write command (note that _plot_index is a variable):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/y2/ ←↩↪→ min/',auth=auth,headers=headers,json=None)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 183
4.11.2 Maximum, if any
sum (optional number) config/plots/N/y2/max/
Maximum value to display on the axis, if any
Maximum, if anyAutomaticMaximum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The minimum value is derived from data and the softminimum
number Maximum Maximum value to display on the axis
Sample requests write command (note that _plot_index is a variable):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/y2/ ←↩↪→ max/',auth=auth,headers=headers,json=None)
Sample CLI write command (note that plot_index is a variable):
uom set "config/plots/${plot_index}/y2/max" "null"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
184 CONTENTS
4.11.3 Soft minimum, if any
sum (optional number) config/plots/N/y2/softmin/
Minimum value to display on the axis unless values exist below it, if any
Soft minimum, if anyNoneSoft minimum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None No soft maximum definednumber Soft minimum Minimum value to display on the axis unless values
exist below it
Sample uom library write command (note that _plot_index is a variable):
uom.config.plots[_plot_index].y2.softmin=null
Sample requests read command (note that _plot_index is a variable):
print(requests.get('http://192.168.0.100/restapi/config/plots/'+str(_plot_index) ←↩↪→ +'/y2/softmin/',auth=auth,headers=headers).json())
⇒None
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 185
4.11.4 Soft maximum, if any
sum (optional number) config/plots/N/y2/softmax/
Maximum value to display on the axis unless values exist above it, if any
Soft maximum, if anyNoneSoft maximum
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None No soft minimum definednumber Soft maximum Maximum value to display on the axis unless values
exist above it
Sample uom library read command (note that _plot_index is a variable):
print(uom.dump(uom.config.plots[_plot_index].y2.softmax))
⇒1
Sample JS request read command (note that _plot_index is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/y2/softmax/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒1
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
186 CONTENTS
4.11.5 Major tick interval, if any
sum (optional number) config/plots/N/y2/tics/
The interval, in value units, between major ticks of the axis, if any
Major tick interval, if anyAutomaticMajor tick interval
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null Automatic The tick interval is derived from data and sizenumber Major tick interval The interval, in value units, between major ticks of the
axis
Sample curl read command (note that :plot_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/plots/:plot_index/y2/tics/"
⇒null
Sample requests write command (note that _plot_index is a variable):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/y2/ ←↩↪→ tics/',auth=auth,headers=headers,json=None)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 187
4.11.6 Minor ticks per major tick, if any
sum (optional number) config/plots/N/y2/mtics/
The number of minor ticks between two major ticks, if any
Minor ticks per major tick, if anyNoneMinor ticks per major tick
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None There are no minor ticksnumber Minor ticks per major tick The number of minor ticks be-
tween two major ticksall of the following is true:
• the value is an integer
• the value is greater orequal to 0
Sample requests write command (note that _plot_index is a variable):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/y2/ ←↩↪→ mtics/',auth=auth,headers=headers,json=None)
Sample JS request write command (note that _plot_index is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/y2/mtics/",body:null});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
188 CONTENTS
4.12 Plot line configuration: Style
object config/plots/N/data/N/style/
Style of the plot line
Stylestyle:Line styletype:Line typecolor:Line colorwidth:Line widthmarker:Marker typesize:Marker sizeaxes:Base axes
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This object contains the following items:
style Line style
type Line type
color Line colorwidth Line widthmarker Marker type
size Marker sizeaxes Base axes
Sample curl write command (note that :plot_index and :plot_line_configuration_index areURL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "{\"type\":\"solid\",\" ←↩↪→ style\":\"lines\",\"width\":1,\"color\":\"FF0000\",\"axes\":\"x1y1\",\" ←↩↪→ marker\":\"plus\",\"size\":0}" "http://192.168.0.100/restapi/config/plots/: ←↩↪→ plot_index/data/:plot_line_configuration_index/style/"
Sample CLI read command (note that plot_index and plot_line_configuration_index arevariables):
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 189
uom get "config/plots/${plot_index}/data/${plot_line_configuration_index}/style"
⇒{"type":"solid","style":"lines","width":1,"color":"FF0000","axes":"x1y1","marker ←↩
↪→ ":"plus","size":0}
Browse more samples
4.12.1 Line style
string config/plots/N/data/N/style/style/
The style of the line
Line style Plot styles[element]:Name
check
The value is subject to the following constraints: plot styles[the value]
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample curl read command (note that :plot_index and :plot_line_configuration_index areURL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/plots/:plot_index/data/:plot_line_configuration_index/style/ ←↩↪→ style/"
⇒"lines"
Sample curl write command (note that :plot_index and :plot_line_configuration_index areURL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "\"lines\"" "http ←↩↪→ ://192.168.0.100/restapi/config/plots/:plot_index/data/: ←↩↪→ plot_line_configuration_index/style/style/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
190 CONTENTS
4.12.2 Line type
string config/plots/N/data/N/style/type/
The type of the line
Line type Line types[element]:Name
check
The value is subject to the following constraints: line types[the value]
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample uom library read command (note that _plot_index and _plot_line_configuration_indexare variables):
print(uom.dump(uom.config.plots[_plot_index].data[_plot_line_configuration_index ←↩↪→ ].style.type))
⇒"solid"
Sample uom library write command (note that _plot_index and _plot_line_configuration_indexare variables):
uom.config.plots[_plot_index].data[_plot_line_configuration_index].style.type=" ←↩↪→ solid"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 191
4.12.3 Line color
string config/plots/N/data/N/style/color/
The color of the line
Line color Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches ∧[0-9A-F]{6}$
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
Sample JS request write command (note that _plot_index and _plot_line_configuration_←↩
index are variables):
request.put({url:"config/plots/"+_plot_index.toString()+"/data/"+ ←↩↪→ _plot_line_configuration_index.toString()+"/style/color/",body:"FF0000"});
Sample uom library write command (note that _plot_index and _plot_line_configuration_indexare variables):
uom.config.plots[_plot_index].data[_plot_line_configuration_index].style.color=" ←↩↪→ FF0000"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
192 CONTENTS
4.12.4 Line width
number config/plots/N/data/N/style/width/
The width of the line
Line width Administrative userAdministratorRegular user
can_read,can_write
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number represents a value in persistent storage.
Sample curl read command (note that :plot_index and :plot_line_configuration_index areURL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/plots/:plot_index/data/:plot_line_configuration_index/style/ ←↩↪→ width/"
⇒1
Sample uom library read command (note that _plot_index and _plot_line_configuration_indexare variables):
print(uom.dump(uom.config.plots[_plot_index].data[_plot_line_configuration_index ←↩↪→ ].style.width))
⇒1
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 193
4.12.5 Marker type
string config/plots/N/data/N/style/marker/
The type of the marker
Marker type Marker types[element]:Name
check
The value is subject to the following constraints: marker types[the value]
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample curl write command (note that :plot_index and :plot_line_configuration_index areURL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "\"plus\"" "http ←↩↪→ ://192.168.0.100/restapi/config/plots/:plot_index/data/: ←↩↪→ plot_line_configuration_index/style/marker/"
Sample curl read command (note that :plot_index and :plot_line_configuration_index areURL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/plots/:plot_index/data/:plot_line_configuration_index/style/ ←↩↪→ marker/"
⇒"plus"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
194 CONTENTS
4.12.6 Marker size
number config/plots/N/data/N/style/size/
The size of the markers
Marker size Administrative userAdministratorRegular user
can_read,can_write
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number represents a value in persistent storage.
Sample JS request write command (note that _plot_index and _plot_line_configuration_←↩
index are variables):
request.put({url:"config/plots/"+_plot_index.toString()+"/data/"+ ←↩↪→ _plot_line_configuration_index.toString()+"/style/size/",body:0});
Sample uom library write command (note that _plot_index and _plot_line_configuration_indexare variables):
uom.config.plots[_plot_index].data[_plot_line_configuration_index].style.size=0
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 195
4.12.7 Base axes
string config/plots/N/data/N/style/axes/
The axes on which the line should be plotted. Units of lines plotted on the same axes must match
Base axes Axes[element]:Name
check
The value is subject to the following constraints: axes[the value]
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample CLI read command (note that plot_index and plot_line_configuration_index arevariables):
uom get "config/plots/${plot_index}/data/${plot_line_configuration_index}/style/ ←↩↪→ axes"
⇒"x1y1"
Sample requests read command (note that _plot_index and _plot_line_configuration_indexare variables):
print(requests.get('http://192.168.0.100/restapi/config/plots/'+str(_plot_index) ←↩↪→ +'/data/'+str(_plot_line_configuration_index)+'/style/axes/',auth=auth, ←↩↪→ headers=headers).json())
⇒'x1y1'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
196 CONTENTS
4.13 Plot: Plot lines
array config/plots/N/data/
Configurations of values to plot
Plot line configurationds:Data sourcetitle:Titlestyle:Style
Plot lines[element]:Plot line configuration 0..*
This array is composite, i.e. is modified as a whole.
This array contains Plot line configuration elements.
Sample JS request read command (note that _plot_index is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/data/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒[{"ds":"power_voltage","style":{"type":"solid","style":"lines","width":1,"color ←↩
↪→ ":"FF0000","axes":"x1y1","marker":"plus","size":0},"title":"Power voltage ←↩↪→ "}]
Sample curl plot line configuration creation command (note that :plot_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 "{\"ds\":\"environment. ←↩↪→ temperature\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width ←↩↪→ \":1,\"color\":\"FF0000\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size ←↩↪→ \":0},\"title\":\"Temperature\"}" "http://192.168.0.100/restapi/config/ ←↩↪→ plots/:plot_index/data/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 197
4.13.1 Plot line configuration
object config/plots/N/data/N/
Properties of a plot line
Stylestyle:Line styletype:Line typecolor:Line colorwidth:Line widthmarker:Marker typesize:Marker sizeaxes:Base axes
Administrative userAdministratorRegular user
can_read,can_write
Plot line configurationds:Data sourcetitle:Titlestyle:Style
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
ds Data sourcetitle Titlestyle Style
Sample CLI read command (note that plot_index and plot_line_configuration_index arevariables):
uom get "config/plots/${plot_index}/data/${plot_line_configuration_index}"
⇒{"ds":"relay_voltage","style":{"type":"solid","style":"lines","width":1,"color":" ←↩
↪→ FF0000","axes":"x1y1","marker":"plus","size":0},"title":"Relay voltage"}
Sample JS request read command (note that _plot_index and _plot_line_configuration_indexare variables):
request.get({url:"config/plots/"+_plot_index.toString()+"/data/"+ ←↩↪→ _plot_line_configuration_index.toString()+"/"},function(error,response,body ←↩↪→ ) {console.log(body)});
⇒{"ds":"environment.illuminance","style":{"type":"solid","style":"lines","width ←↩
↪→ ":1,"color":"FF0000","axes":"x1y1","marker":"plus","size":0},"title":" ←↩↪→ Illuminance"}
Browse more samples
4.13.1.1 Data source
DLI V222 Object Model Reference: 20210317T201932Z
198 CONTENTS
string config/plots/N/data/N/ds/
Identifier of the data source to use
Data source
Measured values[element]:Measured value
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: measured values[the value]
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
Sample JS request read command (note that _plot_index and _plot_line_configuration_indexare variables):
request.get({url:"config/plots/"+_plot_index.toString()+"/data/"+ ←↩↪→ _plot_line_configuration_index.toString()+"/ds/"},function(error,response, ←↩↪→ body) {console.log(body)});
⇒"buses.1.voltage"
Sample CLI write command (note that plot_index and plot_line_configuration_index arevariables):
uom set "config/plots/${plot_index}/data/${plot_line_configuration_index}/ds" "\" ←↩↪→ environment.illuminance\""
Browse more samples
4.13.1.2 Title
string config/plots/N/data/N/title/
The title of the plot line
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 199
Title Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
Sample uom library read command (note that _plot_index and _plot_line_configuration_indexare variables):
print(uom.dump(uom.config.plots[_plot_index].data[_plot_line_configuration_index ←↩↪→ ].title))
⇒"Bus B current"
Sample requests read command (note that _plot_index and _plot_line_configuration_indexare variables):
print(requests.get('http://192.168.0.100/restapi/config/plots/'+str(_plot_index) ←↩↪→ +'/data/'+str(_plot_line_configuration_index)+'/title/',auth=auth,headers= ←↩↪→ headers).json())
⇒'Temperature'
Browse more samples
See also Plot line configuration: Style
DLI V222 Object Model Reference: 20210317T201932Z
200 CONTENTS
4.14 Meters list
array config/meters/
List of meters to display in the web UI
Meter configurationtitle:Titledisplay:Displaydata:Data sourcewidth:Widthheight:Heightscale:Display scaledecimals:Decimalscolor:Arrow colormin_value:Minimum valuesectors:Meter sectors
Meters list[element]:Meter configuration
0..*
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array represents a value in persistent storage.
This array contains Meter configuration elements.
Sample CLI write command:
uom set "config/meters" ...
Sample JS request read command:
request.get({url:"config/meters/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒<...>
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 201
4.14.1 Meter configuration
object config/meters/N/
Configuration of meter for a measured value
Meter sectors[element]:Sector configuration
Administrative userAdministratorRegular user
can_read,can_write
Meter configurationtitle:Titledisplay:Displaydata:Data sourcewidth:Widthheight:Heightscale:Display scaledecimals:Decimalscolor:Arrow colormin_value:Minimum valuesectors:Meter sectors
This object contains the following items:
title Titledisplay Display
data Data sourcewidth Widthheight Height
scale Display scale
decimals Decimalscolor Arrow colormin_value Minimum valuesectors Meter sectors
Sample curl read command (note that :meter_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/meters/:meter_configuration_index/"
⇒
Sample requests write command (note that _meter_configuration_index is a variable):
requests.put('http://192.168.0.100/restapi/config/meters/'+str( ←↩↪→ _meter_configuration_index)+'/',auth=auth,headers=headers,json={'decimals': ←↩↪→ 0, 'color': '', 'sectors': [{'color': '0000FF', 'name': 'Low', 'value': ←↩↪→ 100}, {'color': '00FF00', 'name': 'Optimal', 'value': 127}, {'color': ' ←↩↪→ FF0000', 'name': 'High', 'value': 140}], 'data': 'buses.1.voltage', 'width ←↩↪→ ': 128, 'title': 'Bus B voltage', 'display': False, 'min_value': 90, 'scale ←↩↪→ ': 'linear', 'height': 64})
DLI V222 Object Model Reference: 20210317T201932Z
202 CONTENTS
Browse more samples
See also Meter configuration: Title
See also Meter configuration: Display
See also Meter configuration: Data source
See also Meter configuration: Width
See also Meter configuration: Height
See also Meter configuration: Display scale
See also Meter configuration: Decimals
See also Meter configuration: Arrow color
See also Meter configuration: Minimum value
See also Meter configuration: Meter sectors
4.15 Meter configuration: Title
string config/meters/N/title/
The title of the meter
Title Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample curl write command (note that :meter_configuration_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 "\"Illuminance\"" "http ←↩↪→ ://192.168.0.100/restapi/config/meters/:meter_configuration_index/title/"
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 203
Sample requests write command (note that _meter_configuration_index is a variable):
requests.put('http://192.168.0.100/restapi/config/meters/'+str( ←↩↪→ _meter_configuration_index)+'/title/',auth=auth,headers=headers,json='Bus B ←↩↪→ voltage')
Browse more samples
4.16 Meter configuration: Display
sum (boolean) config/meters/N/display/
Indicates whether the meter should be displayed
DisplayShownHidden
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Shown The meter is shownconstant false Hidden The meter is hidden
Sample curl read command (note that :meter_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/meters/:meter_configuration_index/display/"
⇒true
Sample JS request write command (note that _meter_configuration_index is a variable):
request.put({url:"config/meters/"+_meter_configuration_index.toString()+"/display ←↩↪→ /",body:true});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
204 CONTENTS
4.17 Meter configuration: Data source
string config/meters/N/data/
Identifier of the data source to use
Data source
Measured values[element]:Measured value
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: measured values[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample requests write command (note that _meter_configuration_index is a variable):
requests.put('http://192.168.0.100/restapi/config/meters/'+str( ←↩↪→ _meter_configuration_index)+'/data/',auth=auth,headers=headers,json=' ←↩↪→ environment.illuminance')
Sample uom library write command (note that _meter_configuration_index is a variable):
uom.config.meters[_meter_configuration_index].data="battery_voltage"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 205
4.18 Meter configuration: Width
number config/meters/N/width/
The width of the meter
Width Administrative userAdministratorRegular user
can_read,can_write
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample JS request write command (note that _meter_configuration_index is a variable):
request.put({url:"config/meters/"+_meter_configuration_index.toString()+"/width ←↩↪→ /",body:128});
Sample curl read command (note that :meter_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/meters/:meter_configuration_index/width/"
⇒128
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
206 CONTENTS
4.19 Meter configuration: Height
number config/meters/N/height/
The height of the meter
Height Administrative userAdministratorRegular user
can_read,can_write
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample requests write command (note that _meter_configuration_index is a variable):
requests.put('http://192.168.0.100/restapi/config/meters/'+str( ←↩↪→ _meter_configuration_index)+'/height/',auth=auth,headers=headers,json=64)
Sample CLI write command (note that meter_configuration_index is a variable):
uom set "config/meters/${meter_configuration_index}/height" "64"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 207
4.20 Meter configuration: Display scale
string config/meters/N/scale/
The scale function to use for display
Display scale
Plot scales[element]:Name
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: plot scales[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample uom library write command (note that _meter_configuration_index is a variable):
uom.config.meters[_meter_configuration_index].scale="linear"
Sample JS request read command (note that _meter_configuration_index is a variable):
request.get({url:"config/meters/"+_meter_configuration_index.toString()+"/scale ←↩↪→ /"},function(error,response,body) {console.log(body)});
⇒"linear"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
208 CONTENTS
4.21 Meter configuration: Decimals
number config/meters/N/decimals/
Number of decimal places to show in displayed value
Decimals Administrative userAdministratorRegular user
can_read,can_write
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample JS request read command (note that _meter_configuration_index is a variable):
request.get({url:"config/meters/"+_meter_configuration_index.toString()+"/ ←↩↪→ decimals/"},function(error,response,body) {console.log(body)});
⇒1
Sample curl read command (note that :meter_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/meters/:meter_configuration_index/decimals/"
⇒2
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 209
4.22 Meter configuration: Arrow color
string config/meters/N/color/
The color of the meter arrow
Arrow color Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches ∧[0-9A-F]{6}$
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample JS request write command (note that _meter_configuration_index is a variable):
request.put({url:"config/meters/"+_meter_configuration_index.toString()+"/color ←↩↪→ /",body:""});
Sample uom library write command (note that _meter_configuration_index is a variable):
uom.config.meters[_meter_configuration_index].color=""
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
210 CONTENTS
4.23 Meter configuration: Minimum value
number config/meters/N/min_value/
The minimum value to be displayed on the meter
Minimum value Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample curl write command (note that :meter_configuration_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 "0" "http ←↩↪→ ://192.168.0.100/restapi/config/meters/:meter_configuration_index/min_value ←↩↪→ /"
Sample JS request write command (note that _meter_configuration_index is a variable):
request.put({url:"config/meters/"+_meter_configuration_index.toString()+"/ ←↩↪→ min_value/",body:8});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 211
4.24 Meter configuration: Meter sectors
array config/meters/N/sectors/
Configuration of meter sectors
Sector configurationname:Namevalue:Maximum valuecolor:Color
Meter sectors[element]:Sector configuration
0..*
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array contains Sector configuration elements.
Sample CLI sector configuration creation command (note that meter_configuration_index is a variable):
uom insert "config/meters/${meter_configuration_index}/sectors/1" "{\"color ←↩↪→ \":\"00FF00\",\"name\":\"Optimal\",\"value\":5.5}"
Sample curl read command (note that :meter_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/meters/:meter_configuration_index/sectors/"
⇒[{"color":"00FF00","name":"Optimal","value":12},{"color":"FF0000","name":"High"," ←↩
↪→ value":15}]
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
212 CONTENTS
4.24.1 Sector configuration
object config/meters/N/sectors/N/
Configuration of a meter sector
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
name Namevalue Maximum valuecolor Color
Sample curlwrite command (note that :meter_configuration_index and :sector_configuration←↩
_index are URL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "{\"color\":\"0000FF\",\" ←↩↪→ name\":\"Low\",\"value\":100}" "http://192.168.0.100/restapi/config/meters ←↩↪→ /:meter_configuration_index/sectors/:sector_configuration_index/"
Sample uom library write command (note that _meter_configuration_index and _sector_←↩
configuration_index are variables):
uom.config.meters[_meter_configuration_index].sectors[_sector_configuration_index ←↩↪→ ]={color="00FF00",name="Optimal",value=12}
Browse more samples
4.24.1.1 Name
string config/meters/N/sectors/N/name/
The name of the sector
Name Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 213
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample uom library read command (note that _meter_configuration_index and _sector_←↩
configuration_index are variables):
print(uom.dump(uom.config.meters[_meter_configuration_index].sectors[ ←↩↪→ _sector_configuration_index].name))
⇒"High"
Sample JS request write command (note that _meter_configuration_index and _sector_←↩
configuration_index are variables):
request.put({url:"config/meters/"+_meter_configuration_index.toString()+"/sectors ←↩↪→ /"+_sector_configuration_index.toString()+"/name/",body:"Cold"});
Browse more samples
4.24.1.2 Maximum value
number config/meters/N/sectors/N/value/
The maximum value for the sector
Maximum value Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number represents a value in persistent storage.
Sample CLI read command (note that meter_configuration_index and sector_configuration←↩
_index are variables):
uom get "config/meters/${meter_configuration_index}/sectors/${ ←↩↪→ sector_configuration_index}/value"
⇒
DLI V222 Object Model Reference: 20210317T201932Z
214 CONTENTS
10000
Sample CLI write command (note that meter_configuration_index and sector_configuration←↩
_index are variables):
uom set "config/meters/${meter_configuration_index}/sectors/${ ←↩↪→ sector_configuration_index}/value" "6"
Browse more samples
4.24.1.3 Color
string config/meters/N/sectors/N/color/
The color of the sector
Color Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches ∧[0-9A-F]{6}$
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
Sample curlwrite command (note that :meter_configuration_index and :sector_configuration←↩
_index are URL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "\"00FF00\"" "http ←↩↪→ ://192.168.0.100/restapi/config/meters/:meter_configuration_index/sectors/: ←↩↪→ sector_configuration_index/color/"
Sample uom library write command (note that _meter_configuration_index and _sector_←↩
configuration_index are variables):
uom.config.meters[_meter_configuration_index].sectors[_sector_configuration_index ←↩↪→ ].color="00FF00"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 215
4.25 Primary unit contact
string config/contact/
The person or entity responsible for this unit and information on how to contact them
Primary unit contact
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample JS request read command:
request.get({url:"config/contact/"},function(error,response,body) {console.log( ←↩↪→ body)});
Sample uom library write command:
uom.config.contact="[email protected]"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
216 CONTENTS
4.26 Related contacts
map config/contacts/
Contacts related to the unit in different ways
Contactname:Nameemail:Email, if anyphone:Phone number, if anyfax:Fax number, if any
Administrative userAdministratorRegular user
can_read,can_writeRelated contacts[element]:Contact
0..*
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This map represents a value in persistent storage.
This map contains Contact elements.
Sample uom library contact creation command:
uom.insert(uom.config.contacts,"sales",{email="[email protected]",fax=null, ←↩↪→ name="Sales",phone="+10628316379574"})
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/contacts/',auth=auth,headers= ←↩↪→ headers,json={'engineering': {'phone': '+08670733114697', 'fax': None, ' ←↩↪→ name': 'Engineering', 'email': '[email protected]'}, 'sales': {' ←↩↪→ phone': None, 'fax': '+6887116106248', 'name': 'Sales', 'email': 'sales@bar ←↩↪→ .example.com'}, 'support': {'phone': None, 'fax': None, 'name': 'Support', ←↩↪→ 'email': None}, 'security': {'phone': '+7105471557265', 'fax': None, 'name ←↩↪→ ': 'Security', 'email': None}})
Browse more samples
See also Related contacts: Contact
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 217
4.27 Related contacts: Contact
object config/contacts/S/
Contact properties
Contactname:Nameemail:Email, if anyphone:Phone number, if anyfax:Fax number, if any
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: not index of the value matches ∧(|$.∗)$
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This object represents a value in persistent storage.
This object contains the following items:
name Nameemail Email, if any
phone Phone number, if any
fax Fax number, if any
Sample uom library read command (note that _contact is a variable):
print(uom.dump(uom.config.contacts[_contact]))
⇒{email="[email protected]",fax="+644750733356319",name="Sales",phone ←↩
↪→ ="+35891072446560"}
Sample JS request write command (note that _contact is a variable):
request.put({url:"config/contacts/"+_contact+"/",body:{"phone ←↩↪→ ":"+495323019323612","fax":"+96344370461855","name":"Features","email":null ←↩↪→ }});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
218 CONTENTS
4.27.1 Name
string config/contacts/S/name/
Contact name
Name Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample JS request read command (note that _contact is a variable):
request.get({url:"config/contacts/"+_contact+"/name/"},function(error,response, ←↩↪→ body) {console.log(body)});
⇒"Sales"
Sample requests read command (note that _contact is a variable):
print(requests.get('http://192.168.0.100/restapi/config/contacts/'+_contact+'/ ←↩↪→ name/',auth=auth,headers=headers).json())
⇒'Engineering'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 219
4.27.2 Email, if any
sum (optional string) config/contacts/S/email/
Contact email address, if any
Email, if anyNoneEmail
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null None No email address storedstring Email Contact email address the value is not equal to ""
Sample uom library write command (note that _contact is a variable):
uom.config.contacts[_contact].email=null
Sample JS request read command (note that _contact is a variable):
request.get({url:"config/contacts/"+_contact+"/email/"},function(error,response, ←↩↪→ body) {console.log(body)});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
220 CONTENTS
4.27.3 Phone number, if any
sum (optional string) config/contacts/S/phone/
Contact phone number, if any
Phone number, if anyNonePhone number
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null None No phone number stored
string Phone number Contact phone number the value is not equal to ""
Sample curl read command (note that :contact is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/contacts/:contact/phone/"
⇒"+155889651719849"
Sample CLI read command (note that contact is a variable):
uom get "config/contacts/${contact}/phone"
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 221
4.27.4 Fax number, if any
sum (optional string) config/contacts/S/fax/
Contact fax number, if any
Fax number, if anyNoneFax number
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null None No fax number storedstring Fax number Contact fax number the value is not equal to ""
Sample requests read command (note that _contact is a variable):
print(requests.get('http://192.168.0.100/restapi/config/contacts/'+_contact+'/fax ←↩↪→ /',auth=auth,headers=headers).json())
⇒None
Sample uom library read command (note that _contact is a variable):
print(uom.dump(uom.config.contacts[_contact].fax))
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
222 CONTENTS
4.28 Unit location
string config/location/
The physical location of this unit (e.g. '1st floor, rack 9')
Unit location
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample JS request read command:
request.get({url:"config/location/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒"Server room"
Sample CLI write command:
uom set "config/location" "\"Server room\""
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 223
4.29 Model OID
string config/oid/
Object identifier of unit model (should be registered under dliRegistration OID)
Model OID Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/oid/"
⇒"1.3.6.1.4.1.45770.1.3"
Sample uom library read command:
print(uom.dump(uom.config.oid))
⇒"1.3.6.1.4.1.45770.1.3"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
224 CONTENTS
4.30 Version number
string config/version/
Version number of frontend software
Version number Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample JS request read command:
request.get({url:"config/version/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒"1.8.1.0"
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/version/"
⇒"1.8.1.0"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 225
4.31 Hardware ID
string config/hardware_id/
Identifier of unit hardware model
Hardware ID Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/hardware_id/"
⇒"EPCR5"
Sample JS request read command:
request.get({url:"config/hardware_id/"},function(error,response,body) {console. ←↩↪→ log(body)});
⇒"EPCR5"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
226 CONTENTS
4.32 Serial number
string config/serial/
Unit's serial number
Serial number Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/serial/',auth=auth, ←↩↪→ headers=headers).json())
⇒'V2222203123456'
Sample uom library read command:
print(uom.dump(uom.config.serial))
⇒"V2222203123456"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 227
4.33 Outlet label
string config/outlet_label/
User-visible label for an outlet controlled by a relay
This string does not support direct modification.
This string represents a value in persistent storage.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/outlet_label/',auth=auth, ←↩↪→ headers=headers).json())
⇒'Outlet'
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/outlet_label/"
⇒"Outlet"
Browse more samples
4.34 Brand company name
string config/brand_company_name/
The name of the company which produced the device
Brand company name Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample CLI read command:
DLI V222 Object Model Reference: 20210317T201932Z
228 CONTENTS
uom get "config/brand_company_name"
⇒"Digital Loggers, Inc."
Sample JS request read command:
request.get({url:"config/brand_company_name/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"Digital Loggers, Inc."
Browse more samples
4.35 Brand name
string config/brand_name/
Default brand name, unless overridden
Brand name Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample CLI read command:
uom get "config/brand_name"
⇒"Ethernet Power Controller"
Sample JS request read command:
request.get({url:"config/brand_name/"},function(error,response,body) {console.log ←↩↪→ (body)});
⇒"Ethernet Power Controller"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 229
4.36 Brand URL
string config/brand_url/
Default brand URL, unless overridden
Brand URL Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample uom library read command:
print(uom.dump(uom.config.brand_url))
⇒"https://baz.example.com/baz/quux/bar.htm"
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/brand_url/',auth=auth, ←↩↪→ headers=headers).json())
⇒'https://bar.example.com/foo/foo/quux/quux.htm'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
230 CONTENTS
4.37 Brand manual URL
string config/brand_manual_url/
Brand product manual URL
Brand manual URL Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample JS request read command:
request.get({url:"config/brand_manual_url/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"https://baz.example.com:48443/foo.htm"
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/brand_manual_url/',auth= ←↩↪→ auth,headers=headers).json())
⇒'https://bar.example.com:443/bar.htm'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 231
4.38 Brand FAQ URL
string config/brand_faq_url/
Brand product FAQ URL
Brand FAQ URL Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/brand_faq_url/',auth=auth ←↩↪→ ,headers=headers).json())
⇒'http://baz.example.com/bar/foo/foo.htm'
Sample CLI read command:
uom get "config/brand_faq_url"
⇒"http://foo.example.com/quux/foo.html"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
232 CONTENTS
4.39 Brand product information URL
string config/brand_product_info_url/
Brand product information URL
Brand product information URL Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/brand_product_info_url/"
⇒"http://bar.example.com:1/bar/quux/bar/foo/baz/quux/bar/foo/quux.html"
Sample JS request read command:
request.get({url:"config/brand_product_info_url/"},function(error,response,body) ←↩↪→ {console.log(body)});
⇒"https://foo.example.com:443/baz/baz.htm"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 233
4.40 Support email
string config/support_email/
Product support email
Support email Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/support_email/"
Sample CLI read command:
uom get "config/support_email"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
234 CONTENTS
4.41 Registration URL
string config/register_url/
Default registration URL, unless overridden
Registration URL Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample JS request read command:
request.get({url:"config/register_url/"},function(error,response,body) {console. ←↩↪→ log(body)});
⇒"https://baz.example.com/foo/baz.html"
Sample uom library read command:
print(uom.dump(uom.config.register_url))
⇒"https://bar.example.com/baz/quux.htm"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 235
4.42 Support URL
string config/support_url/
Default support URL, unless overridden
Support URL Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/support_url/"
⇒"https://baz.example.com:18443/foo.html"
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/support_url/',auth=auth, ←↩↪→ headers=headers).json())
⇒'https://baz.example.com:443/foo/quux/quux/quux/quux/bar.htm'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
236 CONTENTS
4.43 Update URL
string config/update_url/
Default update URL, unless overridden
Update URL Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/update_url/"
⇒"https://foo.example.com/bar/baz/quux/quux/baz/bar/bar/bar/baz/foo/baz/foo.html"
Sample CLI read command:
uom get "config/update_url"
⇒"https://foo.example.com:18443/bar.htm"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 237
4.44 Custom brand company name, if any
sum (optional string) config/custom_brand_company_name/
User-visible brand company name, if any
Custom brand company name, if anyDefaultCustom brand company name
Administrative userAdministratorRegular user
can_read,can_write
Customization statusDefaultOpenLocked
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• customization status is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Default Use default brand company name
string Custom brand company name User-visible brand company name the value is not equal to ""
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/custom_brand_company_name/', ←↩↪→ auth=auth,headers=headers,json='Whatever Systems Inc.')
Sample CLI read command:
uom get "config/custom_brand_company_name"
⇒"Whatever Systems Inc."
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
238 CONTENTS
4.45 Custom brand name, if any
sum (optional string) config/custom_brand_name/
User-visible product brand name, if any
Custom brand name, if anyDefaultCustom brand name
Administrative userAdministratorRegular user
can_read,can_write
Customization statusDefaultOpenLocked
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• customization status is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Default Use default product brand name
string Custom brand name User-visible product brand name the value is not equal to ""
Sample CLI write command:
uom set "config/custom_brand_name" "\"Amazing Controller III\""
Sample JS request read command:
request.get({url:"config/custom_brand_name/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"Amazing Controller III"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 239
4.46 Custom brand URL, if any
sum (optional string) config/custom_brand_url/
User-visible brand URL, if any
Custom brand URL, if anyDefaultCustom brand URL
Administrative userAdministratorRegular user
can_read,can_write
Customization statusDefaultOpenLocked
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• customization status is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Default Use default brand URLstring Custom brand URL User-visible brand URL the value is not equal to ""
Sample CLI read command:
uom get "config/custom_brand_url"
⇒"https://bar.example.com:48443/baz/foo.htm"
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://bar.example.com ←↩↪→ /baz.html\"" "http://192.168.0.100/restapi/config/custom_brand_url/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
240 CONTENTS
4.47 Custom brand logo URL, if any
sum (optional string) config/custom_brand_logo/
User-visible brand logo URL, if any
Custom brand logo URL, if anyDefaultCustom brand logo URL
Administrative userAdministratorRegular user
can_read,can_write
Customization statusDefaultOpenLocked
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• customization status is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Default Use default brand logo
string Custom brand logo URL User-visible brand logo URL the value is not equal to ""
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/custom_brand_logo/',auth=auth, ←↩↪→ headers=headers,json='https://foo.example.com/foo/foo/bar/bar/foo.gif')
Sample CLI read command:
uom get "config/custom_brand_logo"
⇒"http://foo.example.com:8064/quux/foo/bar.svg"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 241
4.48 Custom brand logo width, if any
sum (optional number) config/custom_brand_logo_width/
User-visible brand logo width, if any
Custom brand logo width, if anyDefaultCustom brand logo width
Administrative userAdministratorRegular user
can_read,can_write
Customization statusDefaultOpenLocked
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• customization status is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Default Use default brand logo width
number Custom brand logo width User-visible brand logo width
Sample JS request write command:
request.put({url:"config/custom_brand_logo_width/",body:22});
Sample uom library write command:
uom.config.custom_brand_logo_width=22
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
242 CONTENTS
4.49 Custom brand logo height, if any
sum (optional number) config/custom_brand_logo_height/
User-visible brand logo height, if any
Custom brand logo height, if anyDefaultCustom brand logo height
Administrative userAdministratorRegular user
can_read,can_write
Customization statusDefaultOpenLocked
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• customization status is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Default Use default brand logo height
number Custom brand logo height User-visible brand logo height
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 "32" "http ←↩↪→ ://192.168.0.100/restapi/config/custom_brand_logo_height/"
Sample CLI read command:
uom get "config/custom_brand_logo_height"
⇒32
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 243
4.50 Custom support email, if any
sum (optional string) config/custom_support_email/
User-visible product support email, if any
Custom support email, if anyDefaultCustom support email
Administrative userAdministratorRegular user
can_read,can_write
Customization statusDefaultOpenLocked
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• customization status is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Default Use default support email
string Custom support email User-visible product support email the value is not equal to ""
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 "\"[email protected]\"" ←↩↪→ "http://192.168.0.100/restapi/config/custom_support_email/"
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/custom_support_email/',auth= ←↩↪→ auth,headers=headers,json='[email protected]')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
244 CONTENTS
4.51 Custom registration URL, if any
sum (optional string) config/custom_register_url/
User-visible registration URL, if any
Custom registration URL, if anyDefaultCustom registration URL
Administrative userAdministratorRegular user
can_read,can_write
Customization statusDefaultOpenLocked
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• customization status is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Default Use default registration URL
string Custom registration URL User-visible registration URL the value is not equal to ""
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/custom_register_url/',auth=auth ←↩↪→ ,headers=headers,json='https://bar.example.com/foo.htm')
Sample uom library write command:
uom.config.custom_register_url="https://baz.example.com:443/quux/bar/bar.htm"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 245
4.52 Custom support URL, if any
sum (optional string) config/custom_support_url/
User-visible support URL, if any
Custom support URL, if anyDefaultCustom support URL
Administrative userAdministratorRegular user
can_read,can_write
Customization statusDefaultOpenLocked
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• customization status is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Default Use default support URL
string Custom support URL User-visible support URL the value is not equal to ""
Sample CLI write command:
uom set "config/custom_support_url" "\"https://baz.example.com:18443/bar/baz/quux ←↩↪→ .html\""
Sample uom library read command:
print(uom.dump(uom.config.custom_support_url))
⇒"https://baz.example.com/baz.htm"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
246 CONTENTS
4.53 Custom update URL, if any
sum (optional string) config/custom_update_url/
User-visible update URL, if any
Custom update URL, if anyDefaultCustom update URL
Administrative userAdministratorRegular user
can_read,can_write
Customization statusDefaultOpenLocked
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• customization status is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Default Use default update URL
string Custom update URL User-visible update URL the value is not equal to ""
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 "\"https://foo.example. ←↩↪→ com/bar/foo/quux/bar/quux/quux.htm\"" "http://192.168.0.100/restapi/config/ ←↩↪→ custom_update_url/"
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/custom_update_url/',auth=auth, ←↩↪→ headers=headers,json='https://bar.example.com/bar/bar.htm')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 247
4.54 Custom help URL, if any
sum (optional string) config/custom_help_url/
User-visible help URL, if any
Custom help URL, if anyInternal helpCustom help URL
Administrative userAdministratorRegular user
can_read,can_write
Customization statusDefaultOpenLocked
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• customization status is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Internal help Use the internal embedded help system
string Custom help URL User-visible help URL the value is not equal to ""
Sample uom library write command:
uom.config.custom_help_url="https://bar.example.com/foo/quux/baz/baz/quux/baz/bar ←↩↪→ /quux/quux/foo/quux.htm"
Sample JS request read command:
request.get({url:"config/custom_help_url/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"https://bar.example.com:8443/baz.html"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
248 CONTENTS
4.55 Customization status
sum (optional enumerated string) config/customization_status/
Status of customization options
Customization statusDefaultOpenLocked
can_write
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• any of the following is true:
– the value is equal to open
– the value is equal to locked
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Default Customization options can be changed and/or locked
constant "open" Open Customization options can be changed, but cannot belocked
constant "locked" Locked Customization options are locked and cannot bechanged
Sample CLI read command:
uom get "config/customization_status"
⇒null
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/customization_status/',auth= ←↩↪→ auth,headers=headers,json='locked')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 249
4.56 Registration status
sum (boolean) config/registration_status/
Status of the unit registration
Registration statusDefinedUndefined
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Defined The user has either registered the unit, or refused todo so
constant false Undefined The user hasn't decided on registering the unit andneeds to be reminded
Sample uom library write command:
uom.config.registration_status=false
Sample uom library read command:
print(uom.dump(uom.config.registration_status))
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
250 CONTENTS
4.57 Enable page refresh
sum (boolean) config/refresh_enabled/
Periodically refresh web UI status page
Enable page refreshEnabledDisabled
Administrative userAdministratorRegular user
can_write
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/refresh_enabled/',auth=auth, ←↩↪→ headers=headers,json=True)
Sample JS request read command:
request.get({url:"config/refresh_enabled/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 251
4.58 Page refresh delay
number config/refresh_delay_minutes/
Status page refresh delay, if refresh is enabled
Page refresh delay Administrative userAdministratorRegular user
can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/refresh_delay_minutes/', ←↩↪→ auth=auth,headers=headers).json())
⇒1
Sample uom library read command:
print(uom.dump(uom.config.refresh_delay_minutes))
⇒1
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
252 CONTENTS
4.59 Preferred image format
string config/image_format/
Default image format for plots and meters
Preferred image format
Image formats[element]:Name
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: image formats[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample uom library write command:
uom.config.image_format="jpg"
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/image_format/',auth=auth, ←↩↪→ headers=headers,json='svg')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 253
4.60 Unit hostname
string config/hostname/
Host name of the unit (sent by DHCP client, redirected to on network configuration changes when next IP addressis unknown)
Unit hostname
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: the value matches ∧(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]∗[a-zA-Z0-9]).)∗([A-Za-z]([A-Za-z0-9-]∗[A-Za-z0-9])?|[A-Za-z0-9][A-Za-z0-9-]∗[A-Za-z]([A-Za-z0-9-]∗[A-Za-z0-9])?)$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample CLI write command:
uom set "config/hostname" "\"bar.example.com\""
Sample uom library write command:
uom.config.hostname="bar.example.com"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
254 CONTENTS
4.61 Time zone
string config/timezone/
System time zone
Time zone
Known timezones[element]:Timezone
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: known timezones[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/timezone/',auth=auth,headers= ←↩↪→ headers,json='UTC')
Sample uom library read command:
print(uom.dump(uom.config.timezone))
⇒"UTC"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 255
4.62 HTTP ports
array config/http_ports/
HTTP port bindings
Port bindingaddress:Addressport:Port
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
HTTP ports[element]:Port binding
0..*
can_read,can_write
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be suppliedmore than once).
Changes to this array do not take effect immediately.
This array contains Port binding elements.
Sample CLI read command:
uom get "config/http_ports"
⇒[{"port":"80","address":"192.168.0.83"},{"port":"8007","address ←↩
↪→ ":"192.168.0.9"},{"port":"8020","address":"192.168.0.65"},{"port":"80"," ←↩↪→ address":"192.168.0.5"},{"port":"80","address":"192.168.0.78"}]
Sample uom library write command:
uom.config.http_ports={{address="192.168.0.17",port="8088"},{address ←↩↪→ ="192.168.0.92",port="80"},{address="192.168.0.99",port="8089"},{address ←↩↪→ ="192.168.0.48",port="80"}}
Browse more samples
See also HTTP ports: Port binding
DLI V222 Object Model Reference: 20210317T201932Z
256 CONTENTS
4.63 HTTP ports: Port binding
object config/http_ports/N/
Address and port to bind service to
Port bindingaddress:Addressport:Port
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This object is a part of a composite value which is modified as a whole.
This object represents a value in persistent storage.
Changes to this object do not take effect immediately.
This object contains the following items:
address Addressport Port
Sample CLI read command (note that port_binding_index is a variable):
uom get "config/http_ports/${port_binding_index}"
⇒
{"port":"8064","address":"192.168.0.72"}
Sample curl write command (note that :port_binding_index is a URL template argument):
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 257
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "{\"port\":\"80\",\" ←↩↪→ address\":\"192.168.0.8\"}" "http://192.168.0.100/restapi/config/http_ports ←↩↪→ /:port_binding_index/"
Browse more samples
4.63.1 Address
sum (string) config/http_ports/N/address/
Address to listen on
AddressIPv4 addressIPv6 address
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum is a part of a composite value which is modified as a whole.
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
258 CONTENTS
string IPv4 address IPv4 address to listen on the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
string IPv6 address IPv6 address to listen on the value matches ∧(([0-9a-fA-F]{1,4}:){7,7}[0-9a-f←↩
A-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}←↩
:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(←↩
:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-f←↩
A-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-f←↩
A-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|←↩
:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$
Sample requests read command (note that _port_binding_index is a variable):
print(requests.get('http://192.168.0.100/restapi/config/http_ports/'+str( ←↩↪→ _port_binding_index)+'/address/',auth=auth,headers=headers).json())
⇒'192.168.0.13'
Sample CLI read command (note that port_binding_index is a variable):
uom get "config/http_ports/${port_binding_index}/address"
⇒"192.168.0.2"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 259
4.63.2 Port
number config/http_ports/N/port/
Port number to bind to
Port
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
• the value is less than 65535
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This number is a part of a composite value which is modified as a whole.
This number represents a value in persistent storage.
Changes to this number do not take effect immediately.
Sample uom library write command (note that _port_binding_index is a variable):
uom.config.http_ports[_port_binding_index].port="8060"
Sample requests read command (note that _port_binding_index is a variable):
print(requests.get('http://192.168.0.100/restapi/config/http_ports/'+str( ←↩↪→ _port_binding_index)+'/port/',auth=auth,headers=headers).json())
⇒'80'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
260 CONTENTS
4.64 HTTPS ports
array config/https_ports/
HTTPS port bindings
Port bindingaddress:Addressport:Port
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
HTTPS ports[element]:Port binding
0..*
can_read,can_write
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be suppliedmore than once).
Changes to this array do not take effect immediately.
This array contains Port binding elements.
Sample requests port binding creation command:
requests.post('http://192.168.0.100/restapi/config/https_ports/',auth=auth, ←↩↪→ headers=headers,json={'port': '8', 'address': '192.168.0.39'})
Sample curl port binding creation command:
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H ←↩↪→ "Accept: application/json" --data-binary "{\"port\":\"80\",\"address ←↩↪→ \":\"192.168.0.46\"}" "http://192.168.0.100/restapi/config/https_ports/"
Browse more samples
See also HTTPS ports: Port binding
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 261
4.65 HTTPS ports: Port binding
object config/https_ports/N/
Address and port to bind service to
Port bindingaddress:Addressport:Port
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This object is a part of a composite value which is modified as a whole.
This object represents a value in persistent storage.
Changes to this object do not take effect immediately.
This object contains the following items:
address Addressport Port
Sample JS request deletion command (note that _port_binding_index is a variable):
request.delete({url:"config/https_ports/"+_port_binding_index.toString()+"/"});
Sample curl deletion command (note that :port_binding_index is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X DELETE -H "Accept: application/json ←↩↪→ " "http://192.168.0.100/restapi/config/https_ports/:port_binding_index/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
262 CONTENTS
4.65.1 Address
sum (string) config/https_ports/N/address/
Address to listen on
AddressIPv4 addressIPv6 address
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum is a part of a composite value which is modified as a whole.
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
string IPv4 address IPv4 address to listen on the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
string IPv6 address IPv6 address to listen on the value matches ∧(([0-9a-fA-F]{1,4}:){7,7}[0-9a-f←↩
A-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}←↩
:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(←↩
:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-f←↩
A-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-f←↩
A-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|←↩
:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 263
Sample curl read command (note that :port_binding_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/https_ports/:port_binding_index/address/"
⇒"192.168.0.88"
Sample CLI write command (note that port_binding_index is a variable):
uom set "config/https_ports/${port_binding_index}/address" "\"192.168.0.90\""
Browse more samples
4.65.2 Port
number config/https_ports/N/port/
Port number to bind to
Port
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
• the value is less than 65535
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
DLI V222 Object Model Reference: 20210317T201932Z
264 CONTENTS
• not administrative user
• protect network settings
This number is a part of a composite value which is modified as a whole.
This number represents a value in persistent storage.
Changes to this number do not take effect immediately.
Sample CLI write command (note that port_binding_index is a variable):
uom set "config/https_ports/${port_binding_index}/port" "\"80\""
Sample curl write command (note that :port_binding_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 "\"80\"" "http ←↩↪→ ://192.168.0.100/restapi/config/https_ports/:port_binding_index/port/"
Browse more samples
4.66 HTTPS certificate settings
object config/https_cert/
HTTPS certificate configuration
Distinguished name[element]:Values
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Data[element]:Data item
can_read,can_write
can_write
Known DN OIDs[element]:OID
can_read
check
Renewal methods[element]:Renewal method
can_read
check,secret,can_read,can_index
HTTPS certificate settingsbits:Bitsdistinguished_name:Distinguished namestring_mask:String maskdomains:Domain names override, if anyaddresses:Addresses override, if anyautomatic_renewal:Automatic renewalrenewal_method:Certificate renewal methodrenewal_data:Datacsr:HTTPS certificate signing request, if it can be generatedcert:HTTPS certificate chainkey:HTTPS certificate key
renew_cert () -> ( Empty result )
generate_key () -> ( Empty result )
known_dn_oids:Known DN OIDsknown_renewal_methods:Renewal methods
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
bits Bitsdistinguished_name Distinguished name
string_mask String mask
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 265
domains Domain names override, if any
addresses Addresses override, if any
automatic_renewal Automatic renewalrenewal_method Certificate renewal methodrenewal_data Datacsr HTTPS certificate signing request, if it can be generated
cert HTTPS certificate chainkey HTTPS certificate key
renew_cert Renew certificategenerate_key Generate key
known_dn_oids Known DN OIDsknown_renewal_methods Renewal methods
Sample CLI write command:
uom set "config/https_cert" ...
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/https_cert/',auth=auth, ←↩↪→ headers=headers).json())
⇒<...>
Browse more samples
4.66.1 Bits
number config/https_cert/bits/
Size of new private keys
DLI V222 Object Model Reference: 20210317T201932Z
266 CONTENTS
Bits
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This number represents a value in persistent storage.
Sample uom library read command:
print(uom.dump(uom.config.https_cert.bits))
⇒1024
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 "4096" "http ←↩↪→ ://192.168.0.100/restapi/config/https_cert/bits/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 267
4.66.2 Distinguished name
map config/https_cert/distinguished_name/
New certificate distinguished name elements
Values[element]:Value
Administrative userAdministratorRegular user
can_read,can_write
Known DN OIDs[element]:OID
check
Protect network settingsProtectedNot protected
can_write
Distinguished name[element]:Values
0..*
can_read,can_write
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This map is composite, i.e. is modified as a whole.
This map represents a value in persistent storage.
This map contains Values elements.
Sample requests values creation command:
requests.put('http://192.168.0.100/restapi/config/https_cert/distinguished_name/ ←↩↪→ commonName/',auth=auth,headers=headers,json=['Digital Loggers Unit'])
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 "{\"commonName\":[\" ←↩↪→ Digital Loggers Unit\"],\"countryName\":[\"US\"],\"stateOrProvinceName ←↩↪→ \":[\"California\"],\"localityName\":[\"Santa Clara\"]}" "http ←↩↪→ ://192.168.0.100/restapi/config/https_cert/distinguished_name/"
Browse more samples
See also Distinguished name: Values
DLI V222 Object Model Reference: 20210317T201932Z
268 CONTENTS
4.66.3 String mask
sum (enumerated string) config/https_cert/string_mask/
The set of string types to use for new certificates
String maskOpenSSL defaultPKIXUTF-8 strings onlyNo multibyte strings
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant "default" OpenSSL default PrintableString, T61String and BMPString
constant "pkix" PKIX PrintableString and BMPString
constant "utf8only" UTF-8 strings only UTF8String
constant "nombstr" No multibyte strings PrintableString and T61String
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/https_cert/string_mask/',auth= ←↩↪→ auth,headers=headers,json='nombstr')
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/https_cert/string_mask/', ←↩↪→ auth=auth,headers=headers).json())
⇒'pkix'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 269
4.66.4 Domain names override, if any
sum (optional array) config/https_cert/domains/
Explicit domain name list to certify for when enrolling certificate, if any
Domain names override[element]:Hostname
Domain names override, if anyUse hostnameDomain names override
0..1
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Use hostname Certify for the current hostname when enrolling certifi-cate
array Domain names override Explicit domain name list to certify for when enrollingcertificate
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/https_cert/domains/"
⇒["bar.example.com","baz.example.com","baz.example.com"]
Sample JS request write command:
DLI V222 Object Model Reference: 20210317T201932Z
270 CONTENTS
request.put({url:"config/https_cert/domains/",body:null});
Browse more samples
See also Domain names override, if any: Domain names override
4.66.5 Addresses override, if any
sum (optional array) config/https_cert/addresses/
Explicit list of addresses to certify for when enrolling certificate, if any
Addresses override[element]:IPv4 address
Addresses override, if anyUse all known addressesAddresses override
0..1
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Use all known addresses Certify for all current addresses when enrolling certifi-cate automatically
array Addresses override Explicit list of addresses to certify for when enrollingcertificate
Sample uom library read command:
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 271
print(uom.dump(uom.config.https_cert.addresses))
⇒{"210.254.254.26"}
Sample uom library write command:
uom.config.https_cert.addresses={"252.203.250.201"}
Browse more samples
See also Addresses override, if any: Addresses override
4.66.6 Automatic renewal
sum (boolean) config/https_cert/automatic_renewal/
Automatic renewal of certificate at or near expiry
Automatic renewalEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample CLI write command:
uom set "config/https_cert/automatic_renewal" "true"
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 "true" "http ←↩↪→ ://192.168.0.100/restapi/config/https_cert/automatic_renewal/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
272 CONTENTS
4.66.7 Certificate renewal method
string config/https_cert/renewal_method/
Method to use when renewing the certificate
Certificate renewal method
check,secret,can_read,can_index
Administrative userAdministratorRegular user
can_read,can_write
Renewal methods[element]:Renewal method
check
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: renewal methods[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/https_cert/renewal_method/"
⇒"acmev1"
Sample CLI write command:
uom set "config/https_cert/renewal_method" "\"acmev2\""
Browse more samples
See also HTTPS certificate settings: Data
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 273
4.66.8 HTTPS certificate signing request, if it can be generated
sum (variant) config/https_cert/csr/
The certificate signing request to sign (read may fail if key generation is in progress)
HTTPS certificate signing request, if it can be generatedHTTPS certificate signing requestCertificate signing request generation failure
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
string HTTPS certificate signing request The certificate signing request you need to sign in or-der to obtain an HTTPS certificate for the unit, to behonored by an external entity
constant false Certificate signing request generation failure No valid certificate signing request could be generated,check distinguished name settings
Sample uom library read command:
print(uom.dump(uom.config.https_cert.csr))
⇒
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/https_cert/csr/',auth= ←↩↪→ auth,headers=headers).json())
⇒'-----BEGIN CERTIFICATE REQUEST-----\nMIIJSW5r/HUNFyKn7J6f59qzSHQ/mgi5YSQ1/ ←↩
↪→ Yv0rPP7OmwY52DDE3CiNekAKSHv\nzxHuz9KPIkCEIKJYZaeoJ1T3DpXXlUGkRafRl/ ←↩↪→ t4l6K4Sgf2GJsbMLhcBF9zlSjD\nOhqPa==\n-----END CERTIFICATE REQUEST-----\n'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
274 CONTENTS
4.66.9 HTTPS certificate chain
string config/https_cert/cert/
HTTPS certificate chain presented by the unit to clients (read may fail if renewal is in progress)
HTTPS certificate chain
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value contains PEM format data (has native MIME type application/x-pem-file).
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
Using the string as a field for indexing into the grandparent collection is denied
This string represents a value in persistent storage.
This string can change as if by itself or indirectly because of other actions.
Changes to this string cannot be tracked.
Changes to this string may have an effect besides setting value.
Changes to this string do not take effect immediately.
Sample CLI read command:
uom get "config/https_cert/cert"
⇒"-----BEGIN CERTIFICATE-----\nMIIfoeWXwB3TUAcMn0vtTHXSE1o+vOuoKAT9q0jnDoGj+ ←↩
↪→ v6oy1hSLFwbIlcEAW2W\ ←↩↪→ niZaRMpGfZHah5Ylp175zkQkMgxvlUeJCEvgdlyILFv3NUqDXzKXkmI7SF3ElkZ++\ ←↩↪→ ngeGfzdwviKPZZzZvWKirTA7ZRuJ0uKXb\n-----END CERTIFICATE-----\n"
Sample JS request read command:
request.get({url:"config/https_cert/cert/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 275
4.66.10 HTTPS certificate key
string config/https_cert/key/
The key used by the HTTPS certificate presented by the unit; certificate will be renewed as a side effect ofwriting; writing actual data is not recommended, please use the certificate request signing path instead
HTTPS certificate key
Administrative userAdministratorRegular user
can_write
Protect network settingsProtectedNot protected
can_write
The value contains PEM format data (has native MIME type application/x-pem-file).
Retrieving the value is denied
Changing the value is denied if not administrative user
Using the string as a field for indexing into the grandparent collection is denied
This string represents a value in persistent storage.
This string can change as if by itself or indirectly because of other actions.
Changes to this string cannot be tracked.
Changes to this string may have an effect besides setting value.
Changes to this string do not take effect immediately.
This string should be displayed in a secure manner.
Representation of the resource cannot be obtained. Attempts to do so via a JSON API will succeed but return'{"$ref":""}' which means "the value of this resource".
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/https_cert/key/',auth=auth, ←↩↪→ headers=headers,json='-----BEGIN PRIVATE KEY-----\ ←↩↪→ nMII1LcojCQbm4LW182FDcTSGVQMDMGlOo6SAlGvziXlpvIt4M9J+eoHAEgPdyA1n\ ←↩↪→ nz5ov4XSsNOAGUYSqZ7esJvYkYXxcKH8KOzFVXkNw8aDf9iWkrAdA6CxgluJ5CURc\ ←↩↪→ nj80TYze8DJJxs4o2j+BxxujsDq4jIjD1uGXSGBdVXySP3HUpIhmGbV8rMFag/qkv\nHNPU0w2/ ←↩↪→ PT5jzw1gjJIET9dlmKmc4hlO5Av87z9YSGHSDL8ygTDAesxRCj4JRrjY\ ←↩↪→ nfiBeum6B4aQSlO8FdLvWINk2T4WKq4PVpd9jQIxXvN/hoAySXu/rHlwmsS7iZYDO\ ←↩↪→ nP8ek5BgVCNJOMo==\n-----END PRIVATE KEY-----\n')
DLI V222 Object Model Reference: 20210317T201932Z
276 CONTENTS
Sample JS request write command:
request.put({url:"config/https_cert/key/",body:"-----BEGIN PRIVATE KEY-----\nMII/ ←↩↪→ n83wyFlNU4kBARIwDaYGnBAgqiiDTNEHXJEWb/v55gJI7eENEpf10sktaS64\ ←↩↪→ nOPjeyKgtSoan6kSN7iComFgW8H/HNthnJRSHn8BGzn35YXUhGjW2/CaAVbTvVBjq\ ←↩↪→ nB8SMMkLAqTkOzRgj+lkCMwk+QgVePMIcXm+vXM5O==\n-----END PRIVATE KEY-----\n"}) ←↩↪→ ;
Browse more samples
See also HTTPS certificate settings: Renew certificate
See also HTTPS certificate settings: Generate key
See also HTTPS certificate settings: Known DN OIDs
4.66.11 Renewal methods
map config/https_cert/known_renewal_methods/
Known renewal methods
Renewal methodname:Namedata_items:Supported data items
Administrative userAdministratorRegular user
can_readRenewal methods
[element]:Renewal method
0..*
can_read
check,secret,can_read,can_index
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 Renewal method elements.
Creating elements in this collection is not supported.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/https_cert/ ←↩↪→ known_renewal_methods/',auth=auth,headers=headers).json())
⇒<...>
Sample curl read command:
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 277
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/https_cert/known_renewal_methods/"
⇒...
Browse more samples
See also Renewal methods: Renewal method
4.67 Distinguished name: Values
array config/https_cert/distinguished_name/S/
Distinguished name element value set
Values[element]:Value
Administrative userAdministratorRegular user
can_read,can_write
Known DN OIDs[element]:OID
check
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: any of the following is true:
• known DN OIDs[index of the value]
• index of the value matches ∧012{1,}
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
278 CONTENTS
• protect network settings
This array is a part of a composite value which is modified as a whole.
This array represents a value in persistent storage.
This array contains Value elements.
Sample curl read command (note that :values is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/https_cert/distinguished_name/:values/"
⇒["Digital Loggers Unit"]
Sample uom library value creation command (note that _values is a variable):
local composite=uom.copy(uom.config.https_cert.distinguished_name)uom.insert(composite[_values],1,"Santa Clara")uom.config.https_cert.distinguished_name=composite
Browse more samples
4.67.1 Value
string config/https_cert/distinguished_name/S/N/
Distinguished name element value
Value
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 279
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample requests deletion command (note that _values and _value_index are variables):
requests.delete('http://192.168.0.100/restapi/config/https_cert/ ←↩↪→ distinguished_name/'+_values+'/'+str(_value_index)+'/',auth=auth,headers= ←↩↪→ headers)
Sample requests write command (note that _values and _value_index are variables):
requests.put('http://192.168.0.100/restapi/config/https_cert/distinguished_name ←↩↪→ /'+_values+'/'+str(_value_index)+'/',auth=auth,headers=headers,json=' ←↩↪→ Digital Loggers Unit')
Browse more samples
4.68 Domain names override, if any: Domain names override
(possibly) array config/https_cert/domains/
Explicit domain name list to certify for when enrolling certificate
This array contains Hostname elements.
Sample curl hostname creation command:
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H ←↩↪→ "Accept: application/json" --data-binary "\"baz.example.com\"" "http ←↩↪→ ://192.168.0.100/restapi/config/https_cert/domains/"
Sample requests hostname creation command:
requests.post('http://192.168.0.100/restapi/config/https_cert/domains/',auth=auth ←↩↪→ ,headers=headers,json='baz.example.com')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
280 CONTENTS
4.68.1 Hostname
string config/https_cert/domains/N/
Hostname to certify for
Hostname
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: the value matches ∧(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]∗[a-zA-Z0-9]).)∗([A-Za-z]([A-Za-z0-9-]∗[A-Za-z0-9])?|[A-Za-z0-9][A-Za-z0-9-]∗[A-Za-z]([A-Za-z0-9-]∗[A-Za-z0-9])?)$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample curl read command (note that :hostname_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/https_cert/domains/:hostname_index/"
⇒"baz.example.com"
Sample requests write command (note that _hostname_index is a variable):
requests.put('http://192.168.0.100/restapi/config/https_cert/domains/'+str( ←↩↪→ _hostname_index)+'/',auth=auth,headers=headers,json='bar.example.com')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 281
4.69 Addresses override, if any: Addresses override
(possibly) array config/https_cert/addresses/
Explicit list of addresses to certify for when enrolling certificate
This array contains IPv4 address elements.
Sample uom library IPv4 address creation command:
uom.insert(uom.config.https_cert.addresses,2,"254.224.8.13")
Sample requests IPv4 address creation command:
requests.post('http://192.168.0.100/restapi/config/https_cert/addresses/',auth= ←↩↪→ auth,headers=headers,json='254.78.4.227')
Browse more samples
4.69.1 IPv4 address
string config/https_cert/addresses/N/
IPv4 address to certify for, in dotted quad notation
IPv4 address
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
282 CONTENTS
• protect network settings
This string represents a value in persistent storage.
Sample requests write command (note that _ipv4_address_index is a variable):
requests.put('http://192.168.0.100/restapi/config/https_cert/addresses/'+str( ←↩↪→ _ipv4_address_index)+'/',auth=auth,headers=headers,json='8.252.71.12')
Sample curl read command (note that :ipv4_address_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/https_cert/addresses/:ipv4_address_index/"
⇒"209.5.250.250"
Browse more samples
4.70 HTTPS certificate settings: Data
map config/https_cert/renewal_data/
Renewal-method-specific data
Data[element]:Data item
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 283
This map represents a value in persistent storage.
This map contains Data item elements.
Sample requests data item creation command:
requests.put('http://192.168.0.100/restapi/config/https_cert/renewal_data/ ←↩↪→ password/',auth=auth,headers=headers,json='')
Sample CLI data item creation command:
uom insert "config/https_cert/renewal_data/days" "\"23\""
Browse more samples
4.70.1 Data item
string config/https_cert/renewal_data/S/
Item of renewal-method-specific data
Data item
can_read:index,secret:index,can_index:index
Administrative userAdministratorRegular user
can_write,can_read,can_index
Protect network settingsProtectedNot protected
can_write
Renewal methods[element]:Renewal method
check,secret,can_read,can_index
Certificate renewal method
check,secret,can_read,can_index
The value is subject to the following constraints: the value matches renewal methods[certificate renewalmethod].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 ""
– renewal methods[certificate renewal method].data_items[index of the value].secret
DLI V222 Object Model Reference: 20210317T201932Z
284 CONTENTS
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
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 ""
– renewal methods[certificate renewal method].data_items[index of the value].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 ""
• renewal methods[certificate renewal method].data_items[index of the value].secret
Sample uom library write command (note that _data_item is a variable):
uom.config.https_cert.renewal_data[_data_item]="745"
Sample JS request read command (note that _data_item is a variable):
request.get({url:"config/https_cert/renewal_data/"+_data_item+"/"},function(error ←↩↪→ ,response,body) {console.log(body)});
⇒""
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 285
4.71 HTTPS certificate settings: Renew certificate
call config/https_cert/renew_cert/
Initiate attempt to renew the certificate using the selected method
Renew certificate
Administrative userAdministratorRegular user
can_invoke
Protect network settingsProtectedNot protected
can_invoke
Performing the function call is denied if any of the following is true:
• not administrative user
• protect network settings
The call has no arguments (supply empty tuple).
The call returns the following results:
1. Empty result: null
Sample uom library invocation:
uom.config.https_cert.renew_cert()
⇒(no output)
Sample requests invocation:
requests.post('http://192.168.0.100/restapi/config/https_cert/renew_cert/',auth= ←↩↪→ auth,headers=headers,json={})
⇒(no output)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
286 CONTENTS
4.71.1 Empty result
constant null config/https_cert/renew_cert/results: 1/
No additional information available
This constant does not correspond to an actual resource.
4.72 HTTPS certificate settings: Generate key
call config/https_cert/generate_key/
Initiate generation of a new private key; certificate renewal will be attempted as a side effect; if that fails, the keyis unchanged
Generate key
Administrative userAdministratorRegular user
can_invoke
Protect network settingsProtectedNot protected
can_invoke
Performing the function call is denied if any of the following is true:
• not administrative user
• protect network settings
The call has no arguments (supply empty tuple).
The call returns the following results:
1. Empty result: null
Sample uom library invocation:
uom.config.https_cert.generate_key()
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 287
⇒(no output)
Sample JS request invocation:
request.post({url:"config/https_cert/generate_key/",body:[]});
⇒(no output)
Browse more samples
4.72.1 Empty result
constant null config/https_cert/generate_key/results: 1/
No additional information available
This constant does not correspond to an actual resource.
4.73 HTTPS certificate settings: Known DN OIDs
map config/https_cert/known_dn_oids/
Known distinguished name element object identifiers
Known DN OIDs[element]:OID
check
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains OID elements.
Creating elements in this collection is not supported.
Sample requests read command:
DLI V222 Object Model Reference: 20210317T201932Z
288 CONTENTS
print(requests.get('http://192.168.0.100/restapi/config/https_cert/known_dn_oids ←↩↪→ /',auth=auth,headers=headers).json())
⇒
Sample JS request read command:
request.get({url:"config/https_cert/known_dn_oids/"},function(error,response,body ←↩↪→ ) {console.log(body)});
⇒
Browse more samples
4.73.1 OID
string config/https_cert/known_dn_oids/S/
Object identifier value
OID Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample CLI read command (note that oid is a variable):
uom get "config/https_cert/known_dn_oids/${oid}"
⇒"2.5.4.10"
Sample JS request read command (note that _oid is a variable):
request.get({url:"config/https_cert/known_dn_oids/"+_oid+"/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒"2.5.4.19"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 289
4.74 Supported data items: Data item properties
object config/https_cert/known_renewal_methods/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 Nameregexp Regular expression
secret Secret
Sample uom library read command (note that _renewal_method and _data_item_properties arevariables):
print(uom.dump(uom.config.https_cert.known_renewal_methods[_renewal_method]. ←↩↪→ data_items[_data_item_properties]))
⇒{name="Number of days to issue new certificates for",regexp="^[1-9][0-9]*$", ←↩
↪→ secret=false}
Sample JS request write command (note that _renewal_method and _data_item_properties arevariables):
request.put({url:"config/https_cert/known_renewal_methods/"+_renewal_method+"/ ←↩↪→ data_items/"+_data_item_properties+"/",body:{"regexp":"[ -~]*","name":" ←↩↪→ Password to use for authentication","secret":true}});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
290 CONTENTS
4.74.1 Name
string config/https_cert/known_renewal_methods/S/data_items/S/name/
Data item name
Name Administrative userAdministratorRegular user
can_read
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 _renewal_method and _data_item_properties arevariables):
print(uom.dump(uom.config.https_cert.known_renewal_methods[_renewal_method]. ←↩↪→ data_items[_data_item_properties].name))
⇒"ACMEv1 default account key size in bits"
Sample curl read command (note that :renewal_method and :data_item_properties are URL tem-plate arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/https_cert/known_renewal_methods/:renewal_method/data_items ←↩↪→ /:data_item_properties/name/"
⇒"Password to use for authentication"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 291
4.74.2 Regular expression
string config/https_cert/known_renewal_methods/S/data_items/S/regexp/
Regular expression which the data item must match
Regular expression Administrative userAdministratorRegular user
can_read
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 renewal_method and data_item_properties are variables):
uom get "config/https_cert/known_renewal_methods/${renewal_method}/data_items/${ ←↩↪→ data_item_properties}/regexp"
⇒"^[1-9][0-9]*$"
Sample requests read command (note that _renewal_method and _data_item_properties arevariables):
print(requests.get('http://192.168.0.100/restapi/config/https_cert/ ←↩↪→ known_renewal_methods/'+_renewal_method+'/data_items/'+ ←↩↪→ _data_item_properties+'/regexp/',auth=auth,headers=headers).json())
⇒'^((]|[!#&\'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))| )+$'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
292 CONTENTS
4.74.3 Secret
sum (boolean) config/https_cert/known_renewal_methods/S/data_items/S/secret/
Flag indicating whether the data item can contain private information
SecretSecretNot secret
Administrative userAdministratorRegular user
can_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 Secret The data item can contain private information
constant false Not secret The data item contains only public information
Sample JS request read command (note that _renewal_method and _data_item_properties arevariables):
request.get({url:"config/https_cert/known_renewal_methods/"+_renewal_method+"/ ←↩↪→ data_items/"+_data_item_properties+"/secret/"},function(error,response,body ←↩↪→ ) {console.log(body)});
⇒false
Sample uom library read command (note that _renewal_method and _data_item_properties arevariables):
print(uom.dump(uom.config.https_cert.known_renewal_methods[_renewal_method]. ←↩↪→ data_items[_data_item_properties].secret))
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 293
4.75 Renewal methods: Renewal method
object config/https_cert/known_renewal_methods/S/
Method of certificate renewal
Supported data items[element]:Data item properties
Administrative userAdministratorRegular user
can_readRenewal method
name:Namedata_items:Supported data items
can_read
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 Namedata_items Supported data items
Sample CLI write command (note that renewal_method is a variable):
uom set "config/https_cert/known_renewal_methods/${renewal_method}" "{\"name\":\" ←↩↪→ Obtain a certificate from an ACME v2 endpoint (e.g. Let's Encrypt)\",\" ←↩↪→ data_items\":{\"acmev2_auth_algorithm\":{\"regexp\":\"^(RS256|RS384|RS512| ←↩↪→ ES256|ES384|ES512)$\",\"name\":\"ACMEv2 authentication algorithm\",\"secret ←↩↪→ \":false},\"acmev2_contacts\":{\"regexp\":\"^((]|[!#&'()*+,/:;=?@[$A-Za-z0 ←↩↪→ -9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))| )+$\",\"name\":\"ACMEv2 contact URLs, ←↩↪→ whitespace-separated\",\"secret\":false},\"acmev2_agreement\":{\"regexp ←↩↪→ \":\"^((]|[!#&'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))| )+$ ←↩↪→ \",\"name\":\"ACMEv2 service agreement\",\"secret\":false},\"acmev2_url ←↩↪→ \":{\"regexp\":\"^https?://(]|[!#&'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f ←↩↪→ ][0-9A-Fa-f]))+$\",\"name\":\"ACMEv2 directory endpoint URL\",\"secret\": ←↩↪→ false}}}"
Sample uom library read command (note that _renewal_method is a variable):
print(uom.dump(uom.config.https_cert.known_renewal_methods[_renewal_method]))
⇒{data_items={days={name="Number of days to issue new certificates for",regexp ←↩
↪→ ="^[1-9][0-9]*$",secret=false}},name="Generate a self-signed certificate"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
294 CONTENTS
4.75.1 Name
string config/https_cert/known_renewal_methods/S/name/
Renewal method name
Name Administrative userAdministratorRegular user
can_read
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 _renewal_method is a variable):
request.get({url:"config/https_cert/known_renewal_methods/"+_renewal_method+"/ ←↩↪→ name/"},function(error,response,body) {console.log(body)});
⇒"Obtain a certificate from an ACME v1 endpoint (e.g. Let's Encrypt)"
Sample CLI read command (note that renewal_method is a variable):
uom get "config/https_cert/known_renewal_methods/${renewal_method}/name"
⇒"Obtain a certificate from an ACME v1 endpoint (e.g. Let's Encrypt)"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 295
4.75.2 Supported data items
map config/https_cert/known_renewal_methods/S/data_items/
Properties of supported data items
Data item propertiesname:Nameregexp:Regular expressionsecret:Secret
Supported data items[element]:Data item properties
0..*
Administrative userAdministratorRegular user
can_read
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 uom library read command (note that _renewal_method is a variable):
print(uom.dump(uom.config.https_cert.known_renewal_methods[_renewal_method]. ←↩↪→ data_items))
⇒{days={name="Number of days to issue new certificates for",regexp="^[1-9][0-9]*$ ←↩
↪→ ",secret=false}}
Sample CLI read command (note that renewal_method is a variable):
uom get "config/https_cert/known_renewal_methods/${renewal_method}/data_items"
⇒
Browse more samples
See also Supported data items: Data item properties
DLI V222 Object Model Reference: 20210317T201932Z
296 CONTENTS
4.76 Certificate collection
map config/certificates/
Map of known certificates and their settings
Certificatedata:Datastatus:Trust status
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Certificate collection[element]:Certificate
0..*
can_read,can_write
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This map represents a value in persistent storage.
Changes to this map do not take effect immediately.
This map contains Certificate elements.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/certificates/',auth=auth, ←↩↪→ headers=headers).json())
⇒<...>
Sample CLI read command:
uom get "config/certificates"
⇒...
Browse more samples
See also Certificate collection: Certificate
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 297
4.77 Certificate collection: Certificate
object config/certificates/S/
Certificate settings
Certificatedata:Datastatus:Trust status
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This object represents a value in persistent storage.
Changes to this object do not take effect immediately.
This object contains the following items:
data Datastatus Trust status
Sample CLI write command (note that certificate is a variable):
uom set "config/certificates/${certificate}" "{\"data\":\"-----BEGIN CERTIFICATE ←↩↪→ -----\\nMIIrai5cRJMgMFbBPaY8tUSw+tCwKCduE2lqnsTECrwb7YoZ9Nj2uB/u5ErRTVLj\\ ←↩↪→ naM04cFyZs58hgJ5QN/ePwlfoC8JauvkVHnbw2ZVxhfeN/mqPnUqkFWYUgu4bpr67\\ ←↩↪→ nk3iKbf2HKRI6Hjwoag36FZp9gR/Ya8CKDxhrcl8zDT5XD2LpkQy/0nBjFDHrNWCd\\ ←↩↪→ nvU6he5w8DUNHrC1IB3L/H5GWO7vxLY=\\n-----END CERTIFICATE-----\\n\",\"status ←↩↪→ \":true}"
Sample uom library write command (note that _certificate is a variable):
uom.config.certificates[_certificate]={data="-----BEGIN CERTIFICATE-----\MIILXjY49eAT6PmeSR+4VyXISdvN1B6U9Nsj7QqJ40oDSbtx2u1atbvMFqlI1tpD\
DLI V222 Object Model Reference: 20210317T201932Z
298 CONTENTS
yR8pmFraUKBOHGJLsCyoaDeMYhGOxa5w1GlpXdQ2zdSGwnep0cddsI/R0Hrztzvx\hmpKCtKsMdpAHeCvIroctGeB7d47Z2PGqFd38zxXcmjvRxrlpfNix2v5h0FH4hZx\C07B+gqnPlENc0CIQxFUsNCveV/L4yKJ/TX/ANob93/n5E5YBN24mG/Rn1pu/9D0\n2rAtTLyU94lHeygj3T/4xp7mj9yzCdmGUz9zL8UWEFqvDWeI0gPzVZmEkkEzN0G\0RtNcNwtempuJTCLAeLhD7y+uD+HFGAIk3hMTeF7R41maG8mwWUAfT\-----END CERTIFICATE-----\",status=false}
Browse more samples
4.77.1 Data
string config/certificates/S/data/
Certificate data
Data
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value contains PEM format data (has native MIME type application/x-pem-file).
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample uom library read command (note that _certificate is a variable):
print(uom.dump(uom.config.certificates[_certificate].data))
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 299
⇒
Sample requests read command (note that _certificate is a variable):
print(requests.get('http://192.168.0.100/restapi/config/certificates/'+ ←↩↪→ _certificate+'/data/',auth=auth,headers=headers).json())
⇒
Browse more samples
4.77.2 Trust status
sum (boolean) config/certificates/S/status/
Whether the certificate is trusted by default
Trust statusTrustedUntrusted
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
constant true Trusted The certificate is trusted by all software with defaultsettings
constant false Untrusted The certificate is not trusted by all software with defaultsettings
DLI V222 Object Model Reference: 20210317T201932Z
300 CONTENTS
Sample requests write command (note that _certificate is a variable):
requests.put('http://192.168.0.100/restapi/config/certificates/'+_certificate+'/ ←↩↪→ status/',auth=auth,headers=headers,json=True)
Sample curl write command (note that :certificate 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 "true" "http ←↩↪→ ://192.168.0.100/restapi/config/certificates/:certificate/status/"
Browse more samples
4.78 Certificate revocation list collection
map config/crls/
Map of known certificate revocation lists and their settings
Certificate revocation listdata:Datastatus:Usage status
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Certificate revocation list collection[element]:Certificate revocation list
0..*
can_read,can_write
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This map represents a value in persistent storage.
Changes to this map do not take effect immediately.
This map contains Certificate revocation list elements.
Sample CLI write command:
uom set "config/crls" "{\"eCyberBarSign_Primary_CA_8\":{\"data\":\"-----BEGIN ←↩↪→ X509 CRL-----\\nMII0Li2x4fzhUb27y6606CjZxE+ ←↩↪→ UvnW6Ln9jVDgcvgJPIOYGWgJfv2FtJGNE3vNQ\\ ←↩↪→ nAEostjZC8tdjA9QVrLa6EvOeAUZZxJ87Zy0ShbhsUKbgW1COOoWfkxJwRvWPEhYq\\ ←↩↪→ naJOB1GiOtPxxdLMSu1CrM8JIhkZOJP4vkU7omsCgH9=\\n-----END X509 CRL-----\\n ←↩↪→ \",\"status\":false}}"
Sample requests write command:
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 301
requests.put('http://192.168.0.100/restapi/config/crls/',auth=auth,headers= ←↩↪→ headers,json={'eSecureBazCare_Primary_CA': {'data': '-----BEGIN X509 CRL ←↩↪→ -----\nMIIoW0AOeF63d7nggL6bUxES3wM2bNTd5YSeaf2EwAKaK7G0VPe/MvTSrsXTG07O\ ←↩↪→ n2BH7SEKpqgz7jUYNWxI0PAuyfB/pbcRgqkpJ+98rs7/beZ/AXJCzW7xCLz1ybUfS\ ←↩↪→ nVnFhy6Z68BmjCzHYCG4MEIjDLirsNK7v7Oc6XCEhP1Rd1kCF1IdHdMX/5PtUl0Pv\n21+ ←↩↪→ GIihL9LPwZh+uKIXjrYqGSL1U==\n-----END X509 CRL-----\n', 'status': False}})
Browse more samples
See also Certificate revocation list collection: Certificate revocation list
4.79 Certificate revocation list collection: Certificate revocation list
object config/crls/S/
Certificate revocation list settings
Certificate revocation listdata:Datastatus:Usage status
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This object represents a value in persistent storage.
Changes to this object do not take effect immediately.
This object contains the following items:
data Datastatus Usage status
Sample CLI write command (note that certificate_revocation_list is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
302 CONTENTS
uom set "config/crls/${certificate_revocation_list}" "{\"data\":\"-----BEGIN X509 ←↩↪→ CRL-----\\nMIItwPta4AYoO6cJdLrQL2utsVlZ3/VVXSPTuI3/ ←↩↪→ VdpvmRFPp7sABn34IrgOtBvQ\\nvbf/ ←↩↪→ dBeS7RwOtmYlylZ2rtwXHplDGSaB3GDjUtCdL82Exc0vOb+FVxppma323fG9\\ ←↩↪→ nVuSP66nHA1Ep4ADiBVD8K3xx8/0qICoq6GFFO2Yb6pRC0gwDCANYFKWQMZGhn5Xw\\noBotmQ/ ←↩↪→ ctEeaBuoOHNgev61VP==\\n-----END X509 CRL-----\\n\",\"status\":true}"
Sample uom library read command (note that _certificate_revocation_list is a variable):
print(uom.dump(uom.config.crls[_certificate_revocation_list]))
⇒
Browse more samples
4.79.1 Data
string config/crls/S/data/
CRL data
Data
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value contains PEM format data (has native MIME type application/x-pem-file).
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 303
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample requests read command (note that _certificate_revocation_list is a variable):
print(requests.get('http://192.168.0.100/restapi/config/crls/'+ ←↩↪→ _certificate_revocation_list+'/data/',auth=auth,headers=headers).json())
⇒
Sample uom library write command (note that _certificate_revocation_list is a variable):
uom.config.crls[_certificate_revocation_list].data="-----BEGIN X509 CRL-----\MIIaPpnxm6YUBc4bsmHogJIOgIEJ9UHXPq8qfyoS4MzH/3vtrChYY0yEKDZWkt39\0PBrtIEtcFyX8qmrOKtNaEcAmN3sYp6bFKS9ei2G+1q8tc0IyviZAKmzjsrIi+wz\P8/7CI7G8I9mKUlGCLSZ7R=\-----END X509 CRL-----\"
Browse more samples
4.79.2 Usage status
sum (boolean) config/crls/S/status/
Whether the certificate revocation list is used by default
Usage statusUsedUnused
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
304 CONTENTS
• protect network settings
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
constant true Used The certificate revocation list is used by all softwarewith default settings
constant false Unused The certificate revocation list is not used by all softwarewith default settings
Sample curl read command (note that :certificate_revocation_list is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/crls/:certificate_revocation_list/status/"
⇒true
Sample requests write command (note that _certificate_revocation_list is a variable):
requests.put('http://192.168.0.100/restapi/config/crls/'+ ←↩↪→ _certificate_revocation_list+'/status/',auth=auth,headers=headers,json= ←↩↪→ False)
Browse more samples
4.80 SSH enabled
sum (boolean) config/ssh_enabled/
Whether the SSH server should be enabled
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 305
SSH enabledEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/ssh_enabled/',auth=auth,headers ←↩↪→ =headers,json=False)
Sample JS request write command:
request.put({url:"config/ssh_enabled/",body:true});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
306 CONTENTS
4.81 SSH port number
number config/ssh_port/
Port number of the SSH server
SSH port number
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
• the value is less than 65535
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This number represents a value in persistent storage.
Changes to this number do not take effect immediately.
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/ssh_port/',auth=auth,headers= ←↩↪→ headers,json=22)
Sample CLI write command:
uom set "config/ssh_port" "22"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 307
4.82 SSH authorized keys
array config/ssh_authorized_keys/
List of public keys allowed to log in
SSH authorized keydata:Dataoptions:Optionscomment:Comment
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
SSH authorized keys[element]:SSH authorized key
0..*
can_read,can_write
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
Changes to this array do not take effect immediately.
This array contains SSH authorized key elements.
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 "[{\"data\":\"ecdsa-sha2- ←↩↪→ nistp256 8Z==\",\"options\":\"gcpr=ks,mrntd=7747557,h=074,wzq=wtwagvd\",\" ←↩↪→ comment\":\"ot\"},{\"data\":\"ecdsa-sha2-nistp256 7tST=\",\"options ←↩↪→ \":\"\",\"comment\":\"hjifd\"},{\"data\":\"ecdsa-sha2-nistp256 t==\",\" ←↩↪→ options\":\"xb,ffntcrmwjck=48\",\"comment\":\"rf\"},{\"data\":\"ssh-ed25519 ←↩↪→ fs\",\"options\":\"xikv,xa,sply,w=a,fzc=963,ay=850,wgg,njhy=1140881380,or= ←↩↪→ s\",\"comment\":\"zemfux\"}]" "http://192.168.0.100/restapi/config/ ←↩↪→ ssh_authorized_keys/"
Sample requests SSH authorized key creation command:
requests.post('http://192.168.0.100/restapi/config/ssh_authorized_keys/',auth= ←↩↪→ auth,headers=headers,json={'data': 'ecdsa-sha2-nistp256 9===', 'options': ←↩↪→ '', 'comment': ''})
Browse more samples
See also SSH authorized keys: SSH authorized key
DLI V222 Object Model Reference: 20210317T201932Z
308 CONTENTS
4.83 SSH authorized keys: SSH authorized key
object config/ssh_authorized_keys/N/
Public key allowed to log in
SSH authorized keydata:Dataoptions:Optionscomment:Comment
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This object is a part of a composite value which is modified as a whole.
This object represents a value in persistent storage.
Changes to this object do not take effect immediately.
This object contains the following items:
data Dataoptions Options
comment Comment
Sample curl read command (note that :ssh_authorized_key_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/ssh_authorized_keys/:ssh_authorized_key_index/"
⇒{"data":"ssh-dss 0dS","options":"","comment":""}
Sample requests read command (note that _ssh_authorized_key_index is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 309
print(requests.get('http://192.168.0.100/restapi/config/ssh_authorized_keys/'+str ←↩↪→ (_ssh_authorized_key_index)+'/',auth=auth,headers=headers).json())
⇒{'data': 'ecdsa-sha2-nistp521 y0', 'options': 'cjvk,fmfoi', 'comment': ''}
Browse more samples
4.83.1 Data
string config/ssh_authorized_keys/N/data/
Public key data
Data
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: the value matches ∧(([0-9])+ ∗([0-9])+ ∗([0-9])+|(ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-ed25519|ssh-dss|ssh-rsa) ∗([0-9A-Za-z+/]+[=]{0,3}))$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample JS request write command (note that _ssh_authorized_key_index is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
310 CONTENTS
request.put({url:"config/ssh_authorized_keys/"+_ssh_authorized_key_index.toString ←↩↪→ ()+"/data/",body:"ssh-rsa qtC7==="});
Sample CLI write command (note that ssh_authorized_key_index is a variable):
uom set "config/ssh_authorized_keys/${ssh_authorized_key_index}/data" "\"ssh-rsa ←↩↪→ Z=\""
Browse more samples
4.83.2 Options
string config/ssh_authorized_keys/N/options/
Public key options
Options
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: the value matches ∧([∧ "]+|"[∧"]∗")∗$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample requests read command (note that _ssh_authorized_key_index is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 311
print(requests.get('http://192.168.0.100/restapi/config/ssh_authorized_keys/'+str ←↩↪→ (_ssh_authorized_key_index)+'/options/',auth=auth,headers=headers).json())
⇒'qymarpi=7,m=gaqq'
Sample uom library write command (note that _ssh_authorized_key_index is a variable):
uom.config.ssh_authorized_keys[_ssh_authorized_key_index].options="b=10301,ypi=xw ←↩↪→ ,tlvuc=a"
Browse more samples
4.83.3 Comment
string config/ssh_authorized_keys/N/comment/
Public key comment
Comment
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample JS request read command (note that _ssh_authorized_key_index is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
312 CONTENTS
request.get({url:"config/ssh_authorized_keys/"+_ssh_authorized_key_index.toString ←↩↪→ ()+"/comment/"},function(error,response,body) {console.log(body)});
⇒""
Sample curl read command (note that :ssh_authorized_key_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/ssh_authorized_keys/:ssh_authorized_key_index/comment/"
⇒""
Browse more samples
4.84 NTP server enabled
sum (boolean) config/ntp_server_enabled/
Whether the device should act as NTP server
NTP server enabledEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 313
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample uom library read command:
print(uom.dump(uom.config.ntp_server_enabled))
⇒true
Sample uom library write command:
uom.config.ntp_server_enabled=false
Browse more samples
4.85 NTP peers
array config/ntp_peers/
List of NTP servers to get time information from
NTP peers[element]:NTP peer
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This array represents a value in persistent storage.
Changes to this array do not take effect immediately.
This array contains NTP peer elements.
Sample CLI write command:
DLI V222 Object Model Reference: 20210317T201932Z
314 CONTENTS
uom set "config/ntp_peers" "[\"0.ntp-pool.example.com\",\"1.ntp-pool.example.com ←↩↪→ \",\"2.ntp-pool.example.com\",\"3.ntp-pool.example.com\"]"
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 "[\"0.ntp-pool.example. ←↩↪→ com\",\"1.ntp-pool.example.com\",\"2.ntp-pool.example.com\",\"3.ntp-pool. ←↩↪→ example.com\"]" "http://192.168.0.100/restapi/config/ntp_peers/"
Browse more samples
4.85.1 NTP peer
sum (string) config/ntp_peers/N/
NTP server to get time information from
NTP peerHostnameIPv4 address
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
string Hostname Hostname the value matches ∧(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]∗[a-zA-Z0-9]).)∗([A-Za-z]([A-←↩
Za-z0-9-]∗[A-Za-z0-9])?|[A-Za-z0-9][A-Za-z0-9-]∗[A-Za-z]([A-Za-z0-9-]∗[A-Za-z0-9])?)$
string IPv4 address IPv4 address in dotted quad notation the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 315
Sample uom library deletion command (note that _ntp_peer_index is a variable):
uom.remove(uom.config.ntp_peers,_ntp_peer_index)
Sample JS request read command (note that _ntp_peer_index is a variable):
request.get({url:"config/ntp_peers/"+_ntp_peer_index.toString()+"/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒"1.ntp-pool.example.com"
Browse more samples
4.86 Syslog threshold severity
sum (enumerated number) config/syslog_minimal_severity/
Threshold severity for system messages, below which they are not logged
Syslog threshold severityEmergencyAlertCriticalErrorWarningNoticeInformationalDebug
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
316 CONTENTS
constant 1 Emergency Log when unit becomes unstable or unusable
constant 2 Alert Log conditions requiring immediate action
constant 3 Critical Log critical conditions
constant 4 Error Log error conditions
constant 5 Warning Log warning conditions
constant 6 Notice Log normal but significant conditions
constant 7 Informational Log informational messages
constant 8 Debug Log tracing and debugging messages
Sample JS request write command:
request.put({url:"config/syslog_minimal_severity/",body:8});
Sample CLI write command:
uom set "config/syslog_minimal_severity" "8"
Browse more samples
4.87 Syslog server address, if any
sum (optional string) config/syslog_ip_address/
Host name or IPv4 address of the syslog server to forward log messages to, if any
Syslog server address, if anySyslog server disabledHostnameIPv4 address
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 317
constant null Syslog server disabled System log messages are not forwarded to a server
string Hostname Hostname the value matches ∧(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]∗[a-zA-Z0-9]).)∗([A-Za-z]([A-Za-z0-9-]∗[A-Za-z0-9])?|[A-Za-z0-9][A-←↩
Za-z0-9-]∗[A-Za-z]([A-Za-z0-9-]∗[A-Za-z0-9])?)$
string IPv4 address IPv4 address in dotted quad no-tation
the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
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 "null" "http ←↩↪→ ://192.168.0.100/restapi/config/syslog_ip_address/"
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/syslog_ip_address/"
⇒null
Browse more samples
4.88 Allow JSON-RPC
sum (boolean) config/allow_jsonrpc/
Enable HTTP clients to perform JSON-RPC requests
Allow JSON-RPCEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
DLI V222 Object Model Reference: 20210317T201932Z
318 CONTENTS
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample JS request write command:
request.put({url:"config/allow_jsonrpc/",body:false});
Sample uom library read command:
print(uom.dump(uom.config.allow_jsonrpc))
⇒false
Browse more samples
4.89 Allow non-administrative users to perform JSON-RPC requests
sum (boolean) config/allow_jsonrpc_nonadmin/
Enable JSON-RPC API requests from users which are not administrators
Allow non-administrative users to perform JSON-RPC requestsEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 319
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample uom library read command:
print(uom.dump(uom.config.allow_jsonrpc_nonadmin))
⇒false
Sample JS request write command:
request.put({url:"config/allow_jsonrpc_nonadmin/",body:true});
Browse more samples
4.90 Allow REST-like API
sum (boolean) config/allow_restapi/
Enable HTTP clients to perform REST-like API requests
Allow REST-like APIEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
320 CONTENTS
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample uom library write command:
uom.config.allow_restapi=false
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 "false" "http ←↩↪→ ://192.168.0.100/restapi/config/allow_restapi/"
Browse more samples
4.91 Allow non-administrative users to access REST-like API
sum (boolean) config/allow_restapi_nonadmin/
Enable REST-like API requests from users which are not administrators
Allow non-administrative users to access REST-like APIEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 321
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample CLI write command:
uom set "config/allow_restapi_nonadmin" "true"
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/allow_restapi_nonadmin/',auth= ←↩↪→ auth,headers=headers,json=True)
Browse more samples
4.92 Allowed REST-like API client origins
array config/allow_restapi_origins/
List of origins permitted to access the REST-like API
Allowed REST-like API client origins[element]:Allowed REST-like API client origin
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This array represents a value in persistent storage.
This array contains Allowed REST-like API client origin elements.
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 "[\"https://foo.example. ←↩↪→ com:8443\",\"https://bar.example.com:8443\"]" "http://192.168.0.100/restapi ←↩↪→ /config/allow_restapi_origins/"
Sample uom library allowed REST-like API client origin creation command:
uom.insert(uom.config.allow_restapi_origins,1,"http://bar.example.com")
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
322 CONTENTS
4.92.1 Allowed REST-like API client origin
string config/allow_restapi_origins/N/
Origin permitted to access the REST-like API
Allowed REST-like API client origin
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI deletion command (note that allowed_rest_like_api_client_origin_index is avariable):
uom remove "config/allow_restapi_origins/${ ←↩↪→ allowed_rest_like_api_client_origin_index}"
Sample uom library write command (note that _allowed_rest_like_api_client_origin_index is avariable):
uom.config.allow_restapi_origins[_allowed_rest_like_api_client_origin_index]=" ←↩↪→ https://bar.example.com:8443"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 323
4.93 Allow CoAP over WebSockets
sum (boolean) config/allow_coapws/
Enable HTTP clients to establish CoAP over WebSockets connections
Allow CoAP over WebSocketsEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/allow_coapws/',auth=auth, ←↩↪→ headers=headers).json())
⇒False
Sample CLI write command:
uom set "config/allow_coapws" "true"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
324 CONTENTS
4.94 Allow non-administrative users to access CoAP over WebSockets
sum (boolean) config/allow_coapws_nonadmin/
Enable CoAP over WebSockets connections from users which are not administrators
Allow non-administrative users to access CoAP over WebSocketsEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample uom library read command:
print(uom.dump(uom.config.allow_coapws_nonadmin))
⇒false
Sample CLI read command:
uom get "config/allow_coapws_nonadmin"
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 325
4.95 Allowed CoAP over WebSockets client origins
array config/allow_coapws_origins/
List of origins permitted to access CoAP over WebSockets
Allowed CoAP over WebSockets client origins[element]:Allowed CoAP over WebSockets client origin
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This array represents a value in persistent storage.
This array contains Allowed CoAP over WebSockets client origin elements.
Sample curl allowed CoAP over WebSockets client origin creation command:
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H ←↩↪→ "Accept: application/json" --data-binary "\"https://baz.example.com\"" " ←↩↪→ http://192.168.0.100/restapi/config/allow_coapws_origins/"
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/allow_coapws_origins/',auth= ←↩↪→ auth,headers=headers,json=['https://foo.example.com'])
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
326 CONTENTS
4.95.1 Allowed CoAP over WebSockets client origin
string config/allow_coapws_origins/N/
Origin permitted to access CoAP over WebSockets
Allowed CoAP over WebSockets client origin
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample requests read command (note that _allowed_coap_over_websockets_client_origin←↩
_index is a variable):
print(requests.get('http://192.168.0.100/restapi/config/allow_coapws_origins/'+ ←↩↪→ str(_allowed_coap_over_websockets_client_origin_index)+'/',auth=auth, ←↩↪→ headers=headers).json())
⇒'https://baz.example.com'
Sample requests write command (note that _allowed_coap_over_websockets_client_origin←↩
_index is a variable):
requests.put('http://192.168.0.100/restapi/config/allow_coapws_origins/'+str( ←↩↪→ _allowed_coap_over_websockets_client_origin_index)+'/',auth=auth,headers= ←↩↪→ headers,json='http://baz.example.com')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 327
4.96 Relax non-HTML method CSRF checks
sum (boolean) config/relax_nonhtml_methods/
Enable HTTP clients to perform PUT/PATCH/DELETE API requests without a CSRF protection header (currentlycannot be sent via an HTML form)
Relax non-HTML method CSRF checksEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/relax_nonhtml_methods/',auth= ←↩↪→ auth,headers=headers,json=False)
Sample CLI write command:
uom set "config/relax_nonhtml_methods" "true"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
328 CONTENTS
4.97 Relax non-HTML content type CSRF checks
sum (boolean) config/relax_nonhtml_content_types/
Enable HTTP clients to perform API requests with e.g. application/json or application/json-rpc without a CSRFprotection header (currently cannot be sent via an HTML form)
Relax non-HTML content type CSRF checksEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/ ←↩↪→ relax_nonhtml_content_types/',auth=auth,headers=headers).json())
⇒False
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/relax_nonhtml_content_types/', ←↩↪→ auth=auth,headers=headers,json=False)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 329
4.98 Allow plaintext logins
sum (boolean) config/allow_plaintext_logins/
Allow HTTP clients to authenticate using Basic authentication or plaintext login form
Allow plaintext loginsEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample CLI read command:
uom get "config/allow_plaintext_logins"
⇒true
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/allow_plaintext_logins/', ←↩↪→ auth=auth,headers=headers).json())
⇒True
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
330 CONTENTS
4.99 Allow state-changing GET requests
sum (boolean) config/allow_modifying_get/
Allow HTTP clients to use GET web UI requests for changing state
Allow state-changing GET requestsEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample CLI write command:
uom set "config/allow_modifying_get" "true"
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 "false" "http ←↩↪→ ://192.168.0.100/restapi/config/allow_modifying_get/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 331
4.100 Relay name visibility
sum (boolean) config/name_always_visible/
Flag enabling visibility of relay name
Relay name visibilityEverywhereAuthorized users only
Administrative userAdministratorRegular user
can_write
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Everywhere Relay name visible everywhere, including the loginpage
constant false Authorized users only Relay name visible only on pages which require autho-rization
Sample CLI write command:
uom set "config/name_always_visible" "false"
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 "false" "http ←↩↪→ ://192.168.0.100/restapi/config/name_always_visible/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
332 CONTENTS
4.101 Hide user passwords
sum (boolean) config/hide_passwords/
Whether user passwords should be hidden
Hide user passwordsHideShow
can_read
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Hide Do not display user passwords in web UI
constant false Show Display user passwords in web UI
Sample uom library write command:
uom.config.hide_passwords=true
Sample JS request read command:
request.get({url:"config/hide_passwords/"},function(error,response,body) {console ←↩↪→ .log(body)});
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 333
4.102 Hide WiFi key
sum (boolean) config/hide_wifi_key/
Whether the WiFi key should be hidden
Hide WiFi keyHideShow
can_read
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Hide Do not display WiFi key in web UI
constant false Show Display WiFi key in web UI
Sample uom library write command:
uom.config.hide_wifi_key=false
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/hide_wifi_key/"
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
334 CONTENTS
4.103 Security lockout duration
number config/lockout_delay_minutes/
Time during which, after several unsuccessful logins, subsequent logins are denied
Security lockout duration Administrative userAdministratorRegular user
can_read,can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater or equal to 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/lockout_delay_minutes/',auth= ←↩↪→ auth,headers=headers,json=60)
Sample uom library write command:
uom.config.lockout_delay_minutes=60
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 335
4.104 Protect firmware
sum (boolean) config/protect_firmware/
Protect firmware from being overwritten
Protect firmwareProtectedNot protected
can_write
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• the value
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Protected Associated object cannot be changed
constant false Not protected Associated object can be changed
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/protect_firmware/',auth=auth, ←↩↪→ headers=headers,json=True)
Sample CLI read command:
uom get "config/protect_firmware"
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
336 CONTENTS
4.105 Protect admin login
sum (boolean) config/protect_admin/
Protect admin settings from being modified
Protect admin loginProtectedNot protected
can_write
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• the value
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Protected Associated object cannot be changed
constant false Not protected Associated object can be changed
Sample JS request read command:
request.get({url:"config/protect_admin/"},function(error,response,body) {console. ←↩↪→ log(body)});
⇒false
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/protect_admin/',auth=auth, ←↩↪→ headers=headers,json=False)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 337
4.106 Protect network settings
sum (boolean) config/protect_network/
Protect network settings from being modified
Protect network settingsProtectedNot protected
can_write,can_invoke
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• the value
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Protected Associated object cannot be changed
constant false Not protected Associated object can be changed
Sample CLI read command:
uom get "config/protect_network"
⇒true
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 "false" "http ←↩↪→ ://192.168.0.100/restapi/config/protect_network/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
338 CONTENTS
4.107 Protect private settings
sum (boolean) config/protect_private_config/
Protect private configuration settings from being stored in backups
Protect private settingsProtectedNot protected
can_write
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• the value
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Protected Associated object cannot be changed
constant false Not protected Associated object can be changed
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 "false" "http ←↩↪→ ://192.168.0.100/restapi/config/protect_private_config/"
Sample JS request write command:
request.put({url:"config/protect_private_config/",body:true});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 339
4.108 Protect from restore
sum (boolean) config/protect_restore/
Protect settings from being restored from backups
Protect from restoreProtectedNot protected
can_write
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• the value
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Protected Associated object cannot be changed
constant false Not protected Associated object can be changed
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/protect_restore/"
⇒true
Sample JS request read command:
request.get({url:"config/protect_restore/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
340 CONTENTS
4.109 Protect from maintenance
sum (boolean) config/protect_maintenance/
Disable remote maintenance support
Protect from maintenanceProtectedNot protected
can_write
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• the value
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Protected Associated object cannot be changed
constant false Not protected Associated object can be changed
Sample JS request read command:
request.get({url:"config/protect_maintenance/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒true
Sample requests write command:
requests.put('http://192.168.0.100/restapi/config/protect_maintenance/',auth=auth ←↩↪→ ,headers=headers,json=True)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 341
4.110 Protect notification settings
sum (variant) config/protect_notification/
Protect notification settings from being modified
Protect notification settingsProtectedNot protectedProtect sender configuration
can_write Administrative userAdministratorRegular user
can_read,can_write
Agent identifier
can_read
Retrieving the value is denied if all of the following is true:
• not administrative user
• agent identifier is not equal to notification
Changing the value is denied if any of the following is true:
• not administrative user
• the value
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Protected Associated object cannot be changed, and its security-related parameters cannot be read
constant false Not protected Associated object can be changed, and its security-related parameters can be read
constant "sender" Protect sender configuration Associated object cannot be changed, and its security-related parameters cannot be read; properties not re-lated to sender configuration can still be read andchanged
Sample JS request read command:
request.get({url:"config/protect_notification/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒
DLI V222 Object Model Reference: 20210317T201932Z
342 CONTENTS
false
Sample uom library write command:
uom.config.protect_notification=true
Browse more samples
4.111 Beep on upgrade
sum (boolean) config/upgrade_notify_beep/
Indicate firmware upgrade progress by beeping
Beep on upgradeEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/upgrade_notify_beep/"
⇒false
Sample uom library write command:
uom.config.upgrade_notify_beep=true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 343
4.112 Blink on upgrade
sum (boolean) config/upgrade_notify_blink/
Indicate firmware upgrade progress by blinking
Blink on upgradeEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample uom library read command:
print(uom.dump(uom.config.upgrade_notify_blink))
⇒true
Sample JS request read command:
request.get({url:"config/upgrade_notify_blink/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
344 CONTENTS
4.113 Known quantities
map config/known_quantities/
Map of known physical quantities
Quantityname:Nameunits:Known unitspreferred_unit:Preferred unit, if any
Known quantities[element]:Quantity 0..*
check
This map does not support direct modification.
This map represents a value in persistent storage.
This map contains Quantity elements.
Creating elements in this collection is not supported.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/known_quantities/',auth= ←↩↪→ auth,headers=headers).json())
⇒<...>
Sample CLI read command:
uom get "config/known_quantities"
⇒...
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 345
4.113.1 Quantity
object config/known_quantities/S/
Physical quantity
Known units[element]:Unit
check
Administrative userAdministratorRegular user
can_write
Quantityname:Nameunits:Known unitspreferred_unit:Preferred unit, if any
This object contains the following items:
name Nameunits Known unitspreferred_unit Preferred unit, if any
Sample JS request write command (note that _quantity is a variable):
request.put({url:"config/known_quantities/"+_quantity+"/",body:{"preferred_unit ←↩↪→ ":"A","name":"Current","units":{"A":{"offset":0,"internal":false,"name":" ←↩↪→ ampere","scale":1}}}});
Sample CLI read command (note that quantity is a variable):
uom get "config/known_quantities/${quantity}"
⇒{"preferred_unit":"times","name":"Count","units":{"times":{"offset":0,"internal": ←↩
↪→ true,"name":"time","scale":1}}}
Browse more samples
See also Quantity: Name
See also Quantity: Known units
See also Quantity: Preferred unit, if any
DLI V222 Object Model Reference: 20210317T201932Z
346 CONTENTS
4.114 Quantity: Name
string config/known_quantities/S/name/
Quantity name
This string does not support direct modification.
This string represents a value in persistent storage.
Sample CLI read command (note that quantity is a variable):
uom get "config/known_quantities/${quantity}/name"
⇒"Energy"
Sample uom library read command (note that _quantity is a variable):
print(uom.dump(uom.config.known_quantities[_quantity].name))
⇒"Current"
Browse more samples
4.115 Quantity: Known units
map config/known_quantities/S/units/
Map of known units for quantity
Unitname:Namescale:Scaling factoroffset:Offsetinternal:Internal
Administrative userAdministratorRegular user
can_write
InternalInternalUser
readonly
Known units[element]:Unit
0..*
can_write
check
Changing the value is denied if not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 347
This map is composite, i.e. is modified as a whole.
This map represents a value in persistent storage.
This map contains Unit elements.
Sample uom library read command (note that _quantity is a variable):
print(uom.dump(uom.config.known_quantities[_quantity].units))
⇒{J={internal=true,name="joule",offset=0,scale=1},kWh={internal=true,name=" ←↩
↪→ kilowatt-hour",offset=0,scale=2.77777778e-07}}
Sample uom library write command (note that _quantity is a variable):
uom.config.known_quantities[_quantity].units={C={name="degree Celsius",offset ←↩↪→ =-273.16,scale=1},F={name="degree Fahrenheit",offset=-459.67,scale=1.8},K={ ←↩↪→ name="kelvin",offset=0,scale=1}}
Browse more samples
4.115.1 Unit
object config/known_quantities/S/units/S/
Unit of physical quantity
Unitname:Namescale:Scaling factoroffset:Offsetinternal:Internal
Administrative userAdministratorRegular user
can_write
descref__config__known_quantities____units____internal
readonly
Changing 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 does not support direct modification if internal.
This object represents a value in persistent storage.
This object contains the following items:
name Namescale Scaling factor
offset Offsetinternal Internal
DLI V222 Object Model Reference: 20210317T201932Z
348 CONTENTS
Sample requests write command (note that _quantity and _unit are variables):
requests.put('http://192.168.0.100/restapi/config/known_quantities/'+_quantity+'/ ←↩↪→ units/'+_unit+'/',auth=auth,headers=headers,json={'offset': 0, 'internal': ←↩↪→ False, 'name': 'volt', 'scale': 1})
Sample CLI read command (note that quantity and unit are variables):
uom get "config/known_quantities/${quantity}/units/${unit}"
⇒{"offset":0,"internal":true,"name":"","scale":1}
Browse more samples
4.115.1.1 Name
string config/known_quantities/S/units/S/name/
Unit name
Name
Administrative userAdministratorRegular user
can_write
InternalInternalUser
readonly
Changing 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 if internal.
This string represents a value in persistent storage.
Sample CLI read command (note that quantity and unit are variables):
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 349
uom get "config/known_quantities/${quantity}/units/${unit}/name"
⇒"kilowatt-hour"
Sample curl write command (note that :quantity and :unit are URL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "\"volt\"" "http ←↩↪→ ://192.168.0.100/restapi/config/known_quantities/:quantity/units/:unit/name ←↩↪→ /"
Browse more samples
4.115.1.2 Scaling factor
number config/known_quantities/S/units/S/scale/
Scaling factor for conversion from standard SI unit
Scaling factor
Administrative userAdministratorRegular user
can_write
InternalInternalUser
readonly
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number does not support direct modification if internal.
This number represents a value in persistent storage.
Sample curl write command (note that :quantity and :unit are URL template arguments):
DLI V222 Object Model Reference: 20210317T201932Z
350 CONTENTS
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "1" "http ←↩↪→ ://192.168.0.100/restapi/config/known_quantities/:quantity/units/:unit/ ←↩↪→ scale/"
Sample requests read command (note that _quantity and _unit are variables):
print(requests.get('http://192.168.0.100/restapi/config/known_quantities/'+ ←↩↪→ _quantity+'/units/'+_unit+'/scale/',auth=auth,headers=headers).json())
⇒1
Browse more samples
4.115.1.3 Offset
number config/known_quantities/S/units/S/offset/
Offset for conversion from standard SI unit
Offset
Administrative userAdministratorRegular user
can_write
InternalInternalUser
readonly
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number does not support direct modification if internal.
This number represents a value in persistent storage.
Sample requests read command (note that _quantity and _unit are variables):
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 351
print(requests.get('http://192.168.0.100/restapi/config/known_quantities/'+ ←↩↪→ _quantity+'/units/'+_unit+'/offset/',auth=auth,headers=headers).json())
⇒0
Sample uom library write command (note that _quantity and _unit are variables):
uom.config.known_quantities[_quantity].units[_unit].offset=0
Browse more samples
4.115.1.4 Internal
sum (boolean) config/known_quantities/S/units/S/internal/
Flag indicating whether this measurement unit is internal
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Internal This unit is internal and cannot be modifiedconstant false User This unit is user-supplied and can be modified
Sample curl read command (note that :quantity and :unit are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/known_quantities/:quantity/units/:unit/internal/"
⇒true
Sample requests read command (note that _quantity and _unit are variables):
print(requests.get('http://192.168.0.100/restapi/config/known_quantities/'+ ←↩↪→ _quantity+'/units/'+_unit+'/internal/',auth=auth,headers=headers).json())
⇒True
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
352 CONTENTS
4.116 Quantity: Preferred unit, if any
sum (optional string) config/known_quantities/S/preferred_unit/
Default UI unit for quantity, if any
Preferred unit, if anyStandard unitPreferred unit
Administrative userAdministratorRegular user
can_write
Known units[element]:Unit
check
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Standard unit UI shows quantity in SI units
string Preferred unit Default UI unit for quantity known units[the value]
Sample CLI write command (note that quantity is a variable):
uom set "config/known_quantities/${quantity}/preferred_unit" "\"C\""
Sample JS request write command (note that _quantity is a variable):
request.put({url:"config/known_quantities/"+_quantity+"/preferred_unit/",body: ←↩↪→ null});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 353
4.117 Known timezones
map config/known_timezones/
Map of known time zones
Known timezones[element]:Timezone
check
Administrative userAdministratorRegular user
can_read
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 represents a value in persistent storage.
This map contains Timezone 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/config/known_timezones/"
⇒
Sample JS request read command:
request.get({url:"config/known_timezones/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
354 CONTENTS
4.117.1 Timezone
string config/known_timezones/S/
Time zone name
Timezone Administrative userAdministratorRegular user
can_read
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.
This string represents a value in persistent storage.
Sample uom library read command (note that _timezone is a variable):
print(uom.dump(uom.config.known_timezones[_timezone]))
⇒"UTC-6"
Sample curl read command (note that :timezone is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/config/known_timezones/:timezone/"
⇒"UTC+7"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 355
4.118 Known protection bits
map config/known_protection_bits/
Map of known protection bits
Protection bitname:Namestatus:Protection status
Administrative userAdministratorRegular user
can_readKnown protection bits
[element]:Protection bit
0..*
can_read
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 Protection bit 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/config/known_protection_bits/"
⇒
Sample uom library read command:
print(uom.dump(uom.config.known_protection_bits))
⇒
Browse more samples
See also Known protection bits: Protection bit
DLI V222 Object Model Reference: 20210317T201932Z
356 CONTENTS
4.119 Known protection bits: Protection bit
object config/known_protection_bits/S/
Protection bit properties
Protection bitname:Namestatus:Protection status
Administrative userAdministratorRegular user
can_read
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 Namestatus Protection status
Sample requests write command (note that _protection_bit is a variable):
requests.put('http://192.168.0.100/restapi/config/known_protection_bits/'+ ←↩↪→ _protection_bit+'/',auth=auth,headers=headers,json={'name': 'Maintenance ←↩↪→ mode lock', 'status': False})
Sample requests read command (note that _protection_bit is a variable):
print(requests.get('http://192.168.0.100/restapi/config/known_protection_bits/'+ ←↩↪→ _protection_bit+'/',auth=auth,headers=headers).json())
⇒{'name': 'Administrator credentials protection', 'status': True}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 357
4.119.1 Name
string config/known_protection_bits/S/name/
Protection bit name
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 _protection_bit is a variable):
print(requests.get('http://192.168.0.100/restapi/config/known_protection_bits/'+ ←↩↪→ _protection_bit+'/name/',auth=auth,headers=headers).json())
⇒'Private configuration protection'
Sample uom library read command (note that _protection_bit is a variable):
print(uom.dump(uom.config.known_protection_bits[_protection_bit].name))
⇒"Maintenance mode lock"
Browse more samples
4.119.2 Protection status
sum (variant) config/known_protection_bits/S/status/
Status of protection
Protection statusEnabledDisabledIneffective
Administrative userAdministratorRegular user
can_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.
DLI V222 Object Model Reference: 20210317T201932Z
358 CONTENTS
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant true Enabled Protection is enabled and effectiveconstant false Disabled Protection is disabledstring Ineffective Protection is enabled, but not effective for the following
reason
Sample uom library read command (note that _protection_bit is a variable):
print(uom.dump(uom.config.known_protection_bits[_protection_bit].status))
⇒false
Sample JS request read command (note that _protection_bit is a variable):
request.get({url:"config/known_protection_bits/"+_protection_bit+"/status/"}, ←↩↪→ function(error,response,body) {console.log(body)});
⇒false
Browse more samples
4.120 Relay ports
array config/relay_ports/
List of devices to which relay modules are connected
Relay ports[element]:Relay port
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
4 Configuration server object 359
This array does not support direct modification.
This array represents a value in persistent storage.
This array is expected to be visible to advanced users only.
This array contains Relay port elements.
Creating elements in this collection is not supported.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/config/relay_ports/',auth=auth, ←↩↪→ headers=headers).json())
⇒['ttyATH0']
Sample uom library read command:
print(uom.dump(uom.config.relay_ports))
⇒{"ttyATH0"}
Browse more samples
4.120.1 Relay port
string config/relay_ports/N/
Filename of a relay module device
Relay port Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
DLI V222 Object Model Reference: 20210317T201932Z
360 CONTENTS
This string represents a value in persistent storage.
This string is expected to be visible to advanced users only.
Sample uom library read command (note that _relay_port_index is a variable):
print(uom.dump(uom.config.relay_ports[_relay_port_index]))
⇒"ttyATH0"
Sample JS request read command (note that _relay_port_index is a variable):
request.get({url:"config/relay_ports/"+_relay_port_index.toString()+"/"},function ←↩↪→ (error,response,body) {console.log(body)});
⇒"ttyATH0"
Browse more samples
5 Network configuration data
object network/
Data related to network state and configuration
Wired network datamac_address:MAC addressonline:Onlineprotocol:IP address assignment protocolip_address:IP addressnetmask:Network maskgateway:Default gateway IP address, if anymetric:Metricdns_servers:DNS serversserve_dns:DNS server
Administrative userAdministratorRegular user
can_read
Interface priority order[element]:Interface order element
can_read,can_write
Known protocols[element]:Protocol
can_read
check
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
Network configuration datawired:Wired network datawireless:Wireless network data, if anyinterface_order:Interface priority ordersame_subnet_only:Same subnet restrictionknown_protocols:Known protocolsnotifications:Notifications
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 361
wired Wired network datawireless Wireless network data, if any
interface_order Interface priority order
same_subnet_only Same subnet restriction
known_protocols Known protocols
notifications Notifications
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/network/"
Sample JS request write command:
request.put({url:"network/",body:<...>});
Browse more samples
5.1 Wired network data
object network/wired/
Data related to wired network state and configuration
DNS servers[element]:DNS server
Administrative userAdministratorRegular user
can_read,can_write
Wired network datamac_address:MAC addressonline:Onlineprotocol:IP address assignment protocolip_address:IP addressnetmask:Network maskgateway:Default gateway IP address, if anymetric:Metricdns_servers:DNS serversserve_dns:DNS server
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
mac_address MAC addressonline Onlineprotocol IP address assignment protocol
ip_address IP address
netmask Network maskgateway Default gateway IP address, if any
metric Metricdns_servers DNS serversserve_dns DNS server
DLI V222 Object Model Reference: 20210317T201932Z
362 CONTENTS
Sample uom library read command:
print(uom.dump(uom.network.wired))
⇒{dns_servers={"57.87.27.25","220.9.134.9"},gateway="192.168.24.46",ip_address ←↩
↪→ ="192.168.24.63",mac_address="7C:E1:FF:A1:E3:FD",netmask="255.255.255.0", ←↩↪→ online=false,protocol="static",serve_dns=true}
Sample JS request write command:
request.put({url:"network/wired/",body:{"ip_address":"192.168.179.167","serve_dns ←↩↪→ ":false,"protocol":"static","online":true,"gateway":"192.168.179.40"," ←↩↪→ dns_servers":["158.230.136.78","242.201.131.123"],"mac_address":"7C:E1:FF: ←↩↪→ C2:0C:00","netmask":"255.255.255.0"}});
Browse more samples
5.1.1 MAC address
string network/wired/mac_address/
MAC address to use for this interface
MAC address Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches ∧([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample uom library write command:
uom.network.wired.mac_address="7C:E1:FF:B1:4A:50"
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 "\"7C:E1:FF:14:88:A9\"" " ←↩↪→ http://192.168.0.100/restapi/network/wired/mac_address/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 363
5.1.2 Online
sum (boolean) network/wired/online/
Flag indicating the interface online status
OnlineOnlineOffline
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant true Online The interface is onlineconstant false Offline The interface is offline
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/wired/online/"
⇒true
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/network/wired/online/',auth=auth ←↩↪→ ,headers=headers).json())
⇒True
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
364 CONTENTS
5.1.3 IP address assignment protocol
string network/wired/protocol/
Method for obtaining an IP address for this interface
IP address assignment protocol
Known protocols[element]:Protocol
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: known protocols[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample CLI write command:
uom set "network/wired/protocol" "\"dhcp\""
Sample uom library write command:
uom.network.wired.protocol="dhcp"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 365
5.1.4 IP address
string network/wired/ip_address/
IP address to use for this interface
IP address Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
This string can change as if by itself or indirectly because of other actions.
Changes to this string may have an effect besides setting value.
Changes to this string do not take effect immediately.
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/wired/ip_address/"
⇒"10.1.204.131"
Sample JS request read command:
request.get({url:"network/wired/ip_address/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"10.23.163.184"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
366 CONTENTS
5.1.5 Network mask
string network/wired/netmask/
Network mask to use for this interface
Network mask Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches ∧((2(5[42]|4[80]|24)|192|128|0).0.0.0|255.(2(5[42]|4[80]|24)|192|128|0).0.0|255.255.(2(5[42]|4[80]|24)|192|128|0).0|255.255.255.(2(5[542]|4[80]|24)|192|128|0))$
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
This string can change as if by itself or indirectly because of other actions.
Changes to this string may have an effect besides setting value.
Changes to this string do not take effect immediately.
Sample CLI read command:
uom get "network/wired/netmask"
⇒"255.0.0.0"
Sample requests write command:
requests.put('http://192.168.0.100/restapi/network/wired/netmask/',auth=auth, ←↩↪→ headers=headers,json='255.0.0.0')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 367
5.1.6 Default gateway IP address, if any
sum (optional string) network/wired/gateway/
The IP address to send packets which are not targeted to local networks, if any
Default gateway IP address, if anyNo default gatewayDefault gateway IP address
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum may have an effect besides setting value.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
constant null No default gateway Packets with nonlocal destination are dropped
string Default gateway IP address The IP address to send pack-ets which are not targeted tolocal networks
the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/network/wired/gateway/',auth= ←↩↪→ auth,headers=headers).json())
⇒'192.168.130.47'
Sample requests write command:
requests.put('http://192.168.0.100/restapi/network/wired/gateway/',auth=auth, ←↩↪→ headers=headers,json='10.0.0.42')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
368 CONTENTS
5.1.7 Metric
number network/wired/metric/Cost associated with sending packets over this interface
Metric Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
• the value is less or equal to 4294967295
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Changes to this number do not take effect immediately.
Sample requests write command:
requests.put('http://192.168.0.100/restapi/network/wired/metric/',auth=auth, ←↩↪→ headers=headers,json={})
Sample uom library read command:
print(uom.dump(uom.network.wired.metric))
⇒{}
Browse more samples
See also Wired network data: DNS servers
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 369
5.1.8 DNS server
sum (boolean) network/wired/serve_dns/
Respond to DNS queries
DNS serverEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/wired/serve_dns/"
⇒false
Sample JS request read command:
request.get({url:"network/wired/serve_dns/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
370 CONTENTS
5.2 Wired network data: DNS servers
array network/wired/dns_servers/
List of DNS server IP addresses
DNS servers[element]:DNS server
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array can change as if by itself or indirectly because of other actions.
Changes to this array may have an effect besides setting value.
Changes to this array do not take effect immediately.
This array contains DNS server elements.
Sample CLI DNS server creation command:
uom insert "network/wired/dns_servers/1" "\"83.132.226.22\""
Sample JS request DNS server creation command:
request.post({url:"network/wired/dns_servers/",body:"244.227.3.187"});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 371
5.2.1 DNS server
string network/wired/dns_servers/N/
DNS server IP address
The value is subject to the following constraints: the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
This string is a part of a composite value which is modified as a whole.
Sample curl read command (note that :dns_server_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/wired/dns_servers/:dns_server_index/"
⇒"126.9.146.80"
Sample requests read command (note that _dns_server_index is a variable):
print(requests.get('http://192.168.0.100/restapi/network/wired/dns_servers/'+str( ←↩↪→ _dns_server_index)+'/',auth=auth,headers=headers).json())
⇒'37.202.173.236'
Browse more samples
5.3 Wireless network data, if any
sum (optional object) network/wireless/
Data related to wireless network state and configuration, if any
DLI V222 Object Model Reference: 20210317T201932Z
372 CONTENTS
Wireless network dataenabled:Enable wireless moduleonline:Onlinemac_address:MAC addressprotocol:IP address assignment protocolip_address:IP addressnetmask:Network maskgateway:Default gateway IP address, if anymetric:Metricdns_servers:DNS serversserve_dns:DNS servermode:Modeknown_modes:Known modesssid:SSIDchannel:Wireless channelknown_channels:Known channelsencryption:Encryptionknown_encryptions:Known encryptionskey:Keyscan:Scan access pointswac_supported:Wireless Accessory Configuration supportedwac_enabled:Wireless Accessory Configuration enabled
Wireless network data, if anyNo wireless moduleWireless network data
0..1
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can assume the following values:
constant null No wireless module The wireless module is not installedobject Wireless network data Data related to wireless network state and configura-
tion
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/network/wireless/',auth=auth, ←↩↪→ headers=headers).json())
⇒
Sample JS request read command:
request.get({url:"network/wireless/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 373
5.3.1 Wireless network data
(possibly) object network/wireless/
Data related to wireless network state and configuration
DNS servers[element]:DNS server
Administrative userAdministratorRegular user
can_read,can_write
Known modes[element]:Mode
can_read
check
Known channels[element]:Channel
can_readcheck
Known encryptions[element]:Encryption
can_read
check
Wireless network dataenabled:Enable wireless moduleonline:Onlinemac_address:MAC addressprotocol:IP address assignment protocolip_address:IP addressnetmask:Network maskgateway:Default gateway IP address, if anymetric:Metricdns_servers:DNS serversserve_dns:DNS servermode:Modeknown_modes:Known modesssid:SSIDchannel:Wireless channelknown_channels:Known channelsencryption:Encryptionknown_encryptions:Known encryptionskey:Key
scan () -> ( Access points )
wac_supported:Wireless Accessory Configuration supportedwac_enabled:Wireless Accessory Configuration enabled
This object contains the following items:
enabled Enable wireless moduleonline Onlinemac_address MAC addressprotocol IP address assignment protocol
ip_address IP address
netmask Network maskgateway Default gateway IP address, if any
metric Metricdns_servers DNS serversserve_dns DNS servermode Modeknown_modes Known modesssid SSIDchannel Wireless channelknown_channels Known channelsencryption Encryption
known_encryptions Known encryptions
key Key
scan Scan access points
wac_supported Wireless Accessory Configuration supported
wac_enabled Wireless Accessory Configuration enabled
DLI V222 Object Model Reference: 20210317T201932Z
374 CONTENTS
Browse more samples
See also Wireless network data: Enable wireless module
See also Wireless network data: Online
See also Wireless network data: MAC address
See also Wireless network data: IP address assignment protocol
See also Wireless network data: IP address
See also Wireless network data: Network mask
See also Wireless network data: Default gateway IP address, if any
See also Wireless network data: Metric
See also Wireless network data: DNS servers
See also Wireless network data: DNS server
See also Wireless network data: Mode
See also Wireless network data: Known modes
See also Wireless network data: SSID
See also Wireless network data: Wireless channel
See also Wireless network data: Known channels
See also Wireless network data: Encryption
See also Wireless network data: Known encryptions
See also Wireless network data: Key
See also Wireless network data: Scan access points
See also Wireless network data: Wireless Accessory Configuration supported
See also Wireless network data: Wireless Accessory Configuration enabled
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 375
5.4 Wireless network data: Enable wireless module
sum (boolean) network/wireless/enabled/
Flag indicating whether the wireless module is enabled
Enable wireless moduleEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample JS request write command:
request.put({url:"network/wireless/enabled/",body:false});
Sample requests write command:
requests.put('http://192.168.0.100/restapi/network/wireless/enabled/',auth=auth, ←↩↪→ headers=headers,json=True)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
376 CONTENTS
5.5 Wireless network data: Online
sum (boolean) network/wireless/online/
Flag indicating the interface online status
OnlineOnlineOffline
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant true Online The interface is onlineconstant false Offline The interface is offline
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/network/wireless/online/',auth= ←↩↪→ auth,headers=headers).json())
⇒False
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/wireless/online/"
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 377
5.6 Wireless network data: MAC address
string network/wireless/mac_address/
MAC address to use for this interface
MAC address Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches ∧([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample CLI write command:
uom set "network/wireless/mac_address" "\"7C:E1:FF:93:1D:D5\""
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 "\"7C:E1:FF:92:02:82\"" " ←↩↪→ http://192.168.0.100/restapi/network/wireless/mac_address/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
378 CONTENTS
5.7 Wireless network data: IP address assignment protocol
string network/wireless/protocol/
Method for obtaining an IP address for this interface
IP address assignment protocol
Known protocols[element]:Protocol
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: known protocols[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/network/wireless/protocol/',auth ←↩↪→ =auth,headers=headers).json())
⇒'static'
Sample JS request read command:
request.get({url:"network/wireless/protocol/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"dhcp"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 379
5.8 Wireless network data: IP address
string network/wireless/ip_address/
IP address to use for this interface
IP address Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
This string can change as if by itself or indirectly because of other actions.
Changes to this string may have an effect besides setting value.
Changes to this string do not take effect immediately.
Sample JS request read command:
request.get({url:"network/wireless/ip_address/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"10.206.30.62"
Sample CLI read command:
uom get "network/wireless/ip_address"
⇒"192.168.96.157"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
380 CONTENTS
5.9 Wireless network data: Network mask
string network/wireless/netmask/
Network mask to use for this interface
Network mask Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: the value matches ∧((2(5[42]|4[80]|24)|192|128|0).0.0.0|255.(2(5[42]|4[80]|24)|192|128|0).0.0|255.255.(2(5[42]|4[80]|24)|192|128|0).0|255.255.255.(2(5[542]|4[80]|24)|192|128|0))$
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
This string can change as if by itself or indirectly because of other actions.
Changes to this string may have an effect besides setting value.
Changes to this string do not take effect immediately.
Sample JS request read command:
request.get({url:"network/wireless/netmask/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"255.255.255.0"
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/wireless/netmask/"
⇒"255.0.0.0"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 381
5.10 Wireless network data: Default gateway IP address, if any
sum (optional string) network/wireless/gateway/
The IP address to send packets which are not targeted to local networks, if any
Default gateway IP address, if anyNo default gatewayDefault gateway IP address
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum may have an effect besides setting value.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
constant null No default gateway Packets with nonlocal destination are dropped
string Default gateway IP address The IP address to send pack-ets which are not targeted tolocal networks
the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Sample CLI read command:
uom get "network/wireless/gateway"
⇒null
Sample JS request read command:
request.get({url:"network/wireless/gateway/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"10.0.0.35"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
382 CONTENTS
5.11 Wireless network data: Metric
number network/wireless/metric/Cost associated with sending packets over this interface
Metric Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
• the value is less or equal to 4294967295
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Changes to this number do not take effect immediately.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/network/wireless/metric/',auth= ←↩↪→ auth,headers=headers).json())
⇒{}
Sample requests write command:
requests.put('http://192.168.0.100/restapi/network/wireless/metric/',auth=auth, ←↩↪→ headers=headers,json={})
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 383
5.12 Wireless network data: DNS servers
array network/wireless/dns_servers/
List of DNS server IP addresses
DNS servers[element]:DNS server
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array can change as if by itself or indirectly because of other actions.
Changes to this array may have an effect besides setting value.
Changes to this array do not take effect immediately.
This array contains DNS server elements.
Sample uom library write command:
uom.network.wireless.dns_servers={"60.165.72.114"}
Sample CLI read command:
uom get "network/wireless/dns_servers"
⇒["2.85.234.61"]
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
384 CONTENTS
5.12.1 DNS server
string network/wireless/dns_servers/N/
DNS server IP address
The value is subject to the following constraints: the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
This string is a part of a composite value which is modified as a whole.
Sample JS request write command (note that _dns_server_index is a variable):
request.put({url:"network/wireless/dns_servers/"+_dns_server_index.toString() ←↩↪→ +"/",body:"161.24.206.179"});
Sample JS request read command (note that _dns_server_index is a variable):
request.get({url:"network/wireless/dns_servers/"+_dns_server_index.toString() ←↩↪→ +"/"},function(error,response,body) {console.log(body)});
⇒[]
Browse more samples
5.13 Wireless network data: DNS server
sum (boolean) network/wireless/serve_dns/
Respond to DNS queries
DNS serverEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 385
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
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 "true" "http ←↩↪→ ://192.168.0.100/restapi/network/wireless/serve_dns/"
Sample uom library read command:
print(uom.dump(uom.network.wireless.serve_dns))
⇒true
Browse more samples
5.14 Wireless network data: Mode
string network/wireless/mode/
Wireless module mode
Mode
Known modes[element]:Mode
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: known modes[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
DLI V222 Object Model Reference: 20210317T201932Z
386 CONTENTS
Changes to this string do not take effect immediately.
Sample uom library write command:
uom.network.wireless.mode="sta"
Sample JS request read command:
request.get({url:"network/wireless/mode/"},function(error,response,body) {console ←↩↪→ .log(body)});
⇒"ap"
Browse more samples
5.15 Wireless network data: Known modes
map network/wireless/known_modes/
Known wireless modes
Known modes[element]:Mode
check
Administrative userAdministratorRegular user
can_read
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 Mode 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/network/wireless/known_modes/"
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 387
⇒{"sta":"Client","ap":"Access Point"}
Sample uom library read command:
print(uom.dump(uom.network.wireless.known_modes))
⇒{ap="Access Point",sta="Client"}
Browse more samples
5.15.1 Mode
string network/wireless/known_modes/S/
Name of wireless mode
Mode Administrative userAdministratorRegular user
can_read
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 :mode is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/wireless/known_modes/:mode/"
⇒"Access Point"
Sample JS request read command (note that _mode is a variable):
request.get({url:"network/wireless/known_modes/"+_mode+"/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒"Access Point"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
388 CONTENTS
5.16 Wireless network data: SSID
string network/wireless/ssid/
SSID (wireless network name) to use
SSID Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: length of the value is less or equal to 32
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample JS request read command:
request.get({url:"network/wireless/ssid/"},function(error,response,body) {console ←↩↪→ .log(body)});
⇒"an4LJUezt"
Sample JS request write command:
request.put({url:"network/wireless/ssid/",body:"DLI_V22256"});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 389
5.17 Wireless network data: Wireless channel
string network/wireless/channel/
Wireless channel to use
Wireless channel
Known channels[element]:Channel
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: known channels[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample CLI write command:
uom set "network/wireless/channel" "\"auto\""
Sample uom library read command:
print(uom.dump(uom.network.wireless.channel))
⇒"6"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
390 CONTENTS
5.18 Wireless network data: Known channels
map network/wireless/known_channels/
Known wireless channels
Known channels[element]:Channel
check
Administrative userAdministratorRegular user
can_read
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 Channel elements.
Creating elements in this collection is not supported.
Sample CLI read command:
uom get "network/wireless/known_channels"
⇒{"1":"1 (2412 MHz)","auto":"Autoselect","2":"2 (2417 MHz)","5":"5 (2432 MHz) ←↩
↪→ ","4":"4 (2427 MHz)","7":"7 (2442 MHz)","6":"6 (2437 MHz)","9":"9 (2452 MHz ←↩↪→ )","8":"8 (2447 MHz)","3":"3 (2422 MHz)","11":"11 (2462 MHz)","10":"10 ←↩↪→ (2457 MHz)"}
Sample JS request read command:
request.get({url:"network/wireless/known_channels/"},function(error,response,body ←↩↪→ ) {console.log(body)});
⇒{"1":"1 (2412 MHz)","auto":"Autoselect","2":"2 (2417 MHz)","5":"5 (2432 MHz) ←↩
↪→ ","4":"4 (2427 MHz)","7":"7 (2442 MHz)","6":"6 (2437 MHz)","9":"9 (2452 MHz ←↩↪→ )","8":"8 (2447 MHz)","3":"3 (2422 MHz)","11":"11 (2462 MHz)","10":"10 ←↩↪→ (2457 MHz)"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 391
5.18.1 Channel
string network/wireless/known_channels/S/
Name of wireless channel
Channel Administrative userAdministratorRegular user
can_read
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 _channel is a variable):
print(uom.dump(uom.network.wireless.known_channels[_channel]))
⇒"1 (2412 MHz)"
Sample JS request read command (note that _channel is a variable):
request.get({url:"network/wireless/known_channels/"+_channel+"/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒"1 (2412 MHz)"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
392 CONTENTS
5.19 Wireless network data: Encryption
string network/wireless/encryption/
Wireless encryption to use
Encryption
checkKnown encryptions
[element]:Encryption
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: known encryptions[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample uom library write command:
uom.network.wireless.encryption="psk2"
Sample CLI read command:
uom get "network/wireless/encryption"
⇒"psk2"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 393
5.20 Wireless network data: Known encryptions
map network/wireless/known_encryptions/
Known wireless encryptions
Known encryptions[element]:Encryption
check
Administrative userAdministratorRegular user
can_read
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 Encryption elements.
Creating elements in this collection is not supported.
Sample CLI read command:
uom get "network/wireless/known_encryptions"
⇒{"psk2":"WPA2 PSK","psk-mixed":"WPA/WPA2 PSK mixed mode","psk":"WPA PSK","none":" ←↩
↪→ None"}
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/wireless/known_encryptions/"
⇒{"psk2":"WPA2 PSK","psk-mixed":"WPA/WPA2 PSK mixed mode","psk":"WPA PSK","none":" ←↩
↪→ None"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
394 CONTENTS
5.20.1 Encryption
string network/wireless/known_encryptions/S/
Name of wireless encryption
Encryption Administrative userAdministratorRegular user
can_read
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 _encryption is a variable):
print(requests.get('http://192.168.0.100/restapi/network/wireless/ ←↩↪→ known_encryptions/'+_encryption+'/',auth=auth,headers=headers).json())
⇒'WPA PSK'
Sample JS request read command (note that _encryption is a variable):
request.get({url:"network/wireless/known_encryptions/"+_encryption+"/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒"WPA PSK"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 395
5.21 Wireless network data: Key
string network/wireless/key/
Encryption key
Key
Administrative userAdministratorRegular user
can_read,can_write
Encryptioncheck
Hide WiFi keyHideShow
can_read
The value is subject to the following constraints: any of the following is true:
• all of the following is true:
– length of the value is greater or equal to 8
– length of the value is less or equal to 63
• encryption is equal to none
Retrieving the value is denied if any of the following is true:
• not administrative user
• hide WiFi key
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
This string should be displayed in a secure manner.
Sample JS request write command:
DLI V222 Object Model Reference: 20210317T201932Z
396 CONTENTS
request.put({url:"network/wireless/key/",body:"bi$Roq9neTP)@Uc&[email protected] ←↩↪→ tY7N@v7CN*4hvuBK!X#"});
Sample CLI read command:
uom get "network/wireless/key"
⇒"(,COt&/GyDRh3GuiqNiW6,2yjW#cDGRIOptIt(krIC^YeVGV&01A8F"
Browse more samples
5.22 Access points: Access point
object network/wireless/scan/results: 1/N/
Status and configuration of a nearby access point
This object does not correspond to an actual resource.
This object contains the following items:
channel Wireless channelssid SSIDencryption Encryption
signal Signal level
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 397
5.22.1 Wireless channel
string network/wireless/scan/results: 1/N/channel/
Wireless channel of the access point
The value is subject to the following constraints: [invalid reference ../../../../known_channels][the value]
This string does not correspond to an actual resource.
5.22.2 SSID
string network/wireless/scan/results: 1/N/ssid/
SSID (wireless network name) of the access point
The value is subject to the following constraints: length of the value is less or equal to 32
This string does not correspond to an actual resource.
5.22.3 Encryption
string network/wireless/scan/results: 1/N/encryption/
Wireless encryption used by the access point
The value is subject to the following constraints: [invalid reference ../../../../known_encryptions][the value]
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
398 CONTENTS
5.22.4 Signal level
number network/wireless/scan/results: 1/N/signal/
Access point reception signal level, in dBm
This number does not correspond to an actual resource.
5.23 Wireless network data: Scan access points
call network/wireless/scan/Scan and report nearby access points
Access points[element]:Access point
Scan access points
result
Administrative userAdministratorRegular user
can_invoke
Protect network settingsProtectedNot protected
can_invoke
Performing the function call is denied if any of the following is true:
• not administrative user
• protect network settings
The call has no arguments (supply empty tuple).
The call returns the following results:
1. Access points: array of "object "Access point""
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 399
Sample uom library invocation:
print(uom.dump(uom.network.wireless.scan()))
⇒{channel="7",encryption="psk2",signal=-43,ssid="N-Wsk"}
Sample JS request invocation:
request.post({url:"network/wireless/scan/",body:[]});
⇒{"signal":-19,"encryption":"psk2","ssid":"4uFfb","channel":"6"}
Browse more samples
5.23.1 Access points
array network/wireless/scan/results: 1/
List of access points
Access pointchannel:Wireless channelssid:SSIDencryption:Encryptionsignal:Signal level
Access points[element]:Access point 0..*
This array does not correspond to an actual resource.
This array contains Access point elements.
See also Access points: Access point
DLI V222 Object Model Reference: 20210317T201932Z
400 CONTENTS
5.24 Wireless network data: Wireless Accessory Configuration supported
sum (boolean) network/wireless/wac_supported/
Flag indicating device support for Wireless Accessory Configuration
Wireless Accessory Configuration supportedSupportedNot supported
can_write
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can assume the following values:
constant true Supported The device supports WAC
constant false Not supported The device does not support WAC
Sample JS request read command:
request.get({url:"network/wireless/wac_supported/"},function(error,response,body) ←↩↪→ {console.log(body)});
⇒true
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/wireless/wac_supported/"
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 401
5.25 Wireless network data: Wireless Accessory Configuration enabled
sum (boolean) network/wireless/wac_enabled/
Flag indicating whether Wireless Accessory Configuration is currently active (any manual changes automaticallydisable it)
Wireless Accessory Configuration enabledEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Wireless Accessory Configuration supportedSupportedNot supported
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• not wireless Accessory Configuration supported
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample JS request read command:
request.get({url:"network/wireless/wac_enabled/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒false
Sample uom library read command:
print(uom.dump(uom.network.wireless.wac_enabled))
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
402 CONTENTS
5.26 Interface priority order
array network/interface_order/
The order of preference in which interfaces will be used
Interface priority order[element]:Interface order element
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array contains Interface order element elements.
Sample JS request interface order element creation command:
request.post({url:"network/interface_order/",body:[]});
Sample uom library read command:
print(uom.dump(uom.network.interface_order))
⇒{"wireless"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 403
5.26.1 Interface order element
sum (enumerated string) network/interface_order/N/
Element of the interface preference order
This sum is a part of a composite value which is modified as a whole.
This sum can assume the following values:
constant "wired" Wired Wired network interfaceconstant "wireless" Wireless Wireless network interface (if configured)
Sample CLI read command (note that interface_order_element_index is a variable):
uom get "network/interface_order/${interface_order_element_index}"
⇒"wired"
Sample requests read command (note that _interface_order_element_index is a variable):
print(requests.get('http://192.168.0.100/restapi/network/interface_order/'+str( ←↩↪→ _interface_order_element_index)+'/',auth=auth,headers=headers).json())
⇒'wireless'
Browse more samples
5.27 Same subnet restriction
sum (boolean) network/same_subnet_only/
Reject incoming connections from networks other than local subnets
Same subnet restrictionEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
404 CONTENTS
This sum represents a value in persistent storage.
Changes to this sum do not take effect immediately.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/network/same_subnet_only/',auth= ←↩↪→ auth,headers=headers).json())
⇒True
Sample JS request write command:
request.put({url:"network/same_subnet_only/",body:false});
Browse more samples
5.28 Known protocols
map network/known_protocols/
Known IP address assignment protocols
Known protocols[element]:Protocol
check
Administrative userAdministratorRegular user
can_read
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.
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 405
This map contains Protocol elements.
Creating elements in this collection is not supported.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/network/known_protocols/',auth= ←↩↪→ auth,headers=headers).json())
⇒{'dhcp': 'Dynamic IP/DHCP', 'static': 'Static IP'}
Sample JS request read command:
request.get({url:"network/known_protocols/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒{"dhcp":"Dynamic IP/DHCP","static":"Static IP"}
Browse more samples
5.28.1 Protocol
string network/known_protocols/S/
Name of IP address assignment protocol
Protocol Administrative userAdministratorRegular user
can_read
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 protocol is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
406 CONTENTS
uom get "network/known_protocols/${protocol}"
⇒"Dynamic IP/DHCP"
Sample curl read command (note that :protocol is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/known_protocols/:protocol/"
⇒"Static IP"
Browse more samples
5.29 Notifications
object network/notifications/
Network interface status notifications
Parameter kindsnetwork_device:Device namenetwork_link_id:Device indexnetwork_up:Status
check
Events[element]:Event
Administrative userAdministratorRegular user
can_readNotifications
parameter_kinds:Parameter kindsevents:Events
can_read
Retrieving the value is denied if not administrative user
This object does not support direct modification.
This object contains the following items:
parameter_kinds Parameter kinds
events Events
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/notifications/"
⇒
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 407
Sample CLI read command:
uom get "network/notifications"
⇒
Browse more samples
See also Notifications: Parameter kinds
5.29.1 Events
map network/notifications/events/
Event templates
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
Events[element]:Event
0..*
Administrative userAdministratorRegular user
can_read
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 Event elements.
Creating elements in this collection is not supported.
Sample JS request read command:
request.get({url:"network/notifications/events/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒
DLI V222 Object Model Reference: 20210317T201932Z
408 CONTENTS
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/network/notifications/events/', ←↩↪→ auth=auth,headers=headers).json())
⇒
Browse more samples
See also Events: Event
5.30 Notifications: Parameter kinds
object network/notifications/parameter_kinds/
Kinds of event parameters
This object does not correspond to an actual resource.
This object contains the following items:
network_device Device namenetwork_link←↩
_idDevice index
network_up Status
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 409
5.30.1 Device name
string network/notifications/parameter_kinds/network_device/
Low-level network interface name
5.30.2 Device index
number network/notifications/parameter_kinds/network_link_id/
Low-level network interface index
The value is subject to the following constraints: the value is an integer
5.30.3 Status
sum (boolean) network/notifications/parameter_kinds/network_up/
Network interface status
This sum can assume the following values:
constant true Up The network interface is connected
constant false Down The network interface is disconnected
DLI V222 Object Model Reference: 20210317T201932Z
410 CONTENTS
5.31 Event parameters: Event parameter
object network/notifications/events/S/parameters/N/
Properties of a parameter associated with the event
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
id Identifierhas_fixed_value Fixed value flag
fixed_value Fixed value
Sample curl write command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "{\"fixed_value\":null,\" ←↩↪→ has_fixed_value\":false,\"id\":\"network_link_id\"}" "http://192.168.0.100/ ←↩↪→ restapi/network/notifications/events/:event/parameters/: ←↩↪→ event_parameter_index/"
Sample uom library write command (note that _event and _event_parameter_index are variables):
uom.network.notifications.events[_event].parameters[_event_parameter_index]={ ←↩↪→ fixed_value=null,has_fixed_value=false,id="network_link_id"}
Browse more samples
5.31.1 Identifier
string network/notifications/events/S/parameters/N/id/
Parameter identifier
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 411
Identifier
Parameter kindsnetwork_device:Device namenetwork_link_id:Device indexnetwork_up:Status
check
Administrative userAdministratorRegular user
can_read
The value is subject to the following constraints: parameter kinds[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 _event and _event_parameter_index are variables):
request.get({url:"network/notifications/events/"+_event+"/parameters/"+ ←↩↪→ _event_parameter_index.toString()+"/id/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"network_up"
Sample CLI read command (note that event and event_parameter_index are variables):
uom get "network/notifications/events/${event}/parameters/${event_parameter_index ←↩↪→ }/id"
⇒"network_device"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
412 CONTENTS
5.31.2 Fixed value flag
sum (boolean) network/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
Fixed value flagFixedVariable
Administrative userAdministratorRegular user
can_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 Fixed The value is fixedconstant false Variable The value is variable
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.network.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].has_fixed_value))
⇒false
Sample curl read command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/notifications/events/:event/parameters/: ←↩↪→ event_parameter_index/has_fixed_value/"
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 413
5.31.3 Fixed value
sum (variant) network/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
Fixed valueNullTrueFalseStringNumber
Administrative userAdministratorRegular user
can_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 null Null Nullconstant true True Trueconstant false False Falsestring String This string
number Number This number
Sample curl read command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/notifications/events/:event/parameters/: ←↩↪→ event_parameter_index/fixed_value/"
⇒
null
Sample uom library read command (note that _event and _event_parameter_index are variables):
DLI V222 Object Model Reference: 20210317T201932Z
414 CONTENTS
print(uom.dump(uom.network.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].fixed_value))
⇒null
Browse more samples
5.32 Events: Event
object network/notifications/events/S/
Event template
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
can_readcheck
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
message_template Message template
severity Severity
parameters Event parameters
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/network/notifications/events/'+ ←↩↪→ _event+'/',auth=auth,headers=headers).json())
⇒
Sample uom library write command (note that _event is a variable):
uom.network.notifications.events[_event]={message_template={"Interface \"",0,"\" ←↩↪→ is down"},parameters={{fixed_value=null,has_fixed_value=false,id=" ←↩↪→ network_device"},{fixed_value=null,has_fixed_value=false,id=" ←↩↪→ network_link_id"},{fixed_value=false,has_fixed_value=true,id="network_up ←↩↪→ "}},severity=5}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 415
5.32.1 Message template
array network/notifications/events/S/message_template/
Template for human-readable message generation
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Message template element elements.
Creating elements in this collection is not supported.
Sample CLI read command (note that event is a variable):
uom get "network/notifications/events/${event}/message_template"
⇒["Interface \"",0,"\" is up"]
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.network.notifications.events[_event].message_template))
⇒{"Interface \"",0,"\" is down"}
Browse more samples
5.32.1.1 Message template element
sum (variant) network/notifications/events/S/message_template/N/
Element of human-readable message template
DLI V222 Object Model Reference: 20210317T201932Z
416 CONTENTS
Message template elementStringParameter
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
check
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:
string String Fixed string
number Parameter Index of message parameter to insert event parameters[the value]
Sample CLI read command (note that event and message_template_element_index are variables):
uom get "network/notifications/events/${event}/message_template/${ ←↩↪→ message_template_element_index}"
⇒"\" is up"
Sample requests read command (note that _event and _message_template_element_index arevariables):
print(requests.get('http://192.168.0.100/restapi/network/notifications/events/'+ ←↩↪→ _event+'/message_template/'+str(_message_template_element_index)+'/',auth= ←↩↪→ auth,headers=headers).json())
⇒'" is down'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
5 Network configuration data 417
5.32.2 Severity
sum (enumerated number) network/notifications/events/S/severity/
Severity rating assigned to the event
SeverityEmergencyAlertCriticalErrorWarningNoticeInformationalDebug
Administrative userAdministratorRegular user
can_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 1 Emergency Treat the event as an emergency
constant 2 Alert Treat the event as an alertconstant 3 Critical Treat the event as criticalconstant 4 Error Treat the event as an errorconstant 5 Warning Treat the event as a warning
constant 6 Notice Treat the event as a noticeconstant 7 Informational Treat the event as informationalconstant 8 Debug Treat the event as debugging-related
Sample JS request read command (note that _event is a variable):
request.get({url:"network/notifications/events/"+_event+"/severity/"},function( ←↩↪→ error,response,body) {console.log(body)});
DLI V222 Object Model Reference: 20210317T201932Z
418 CONTENTS
⇒6
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/network/notifications/events/'+ ←↩↪→ _event+'/severity/',auth=auth,headers=headers).json())
⇒5
Browse more samples
5.32.3 Event parameters
array network/notifications/events/S/parameters/
Additional data associated with the event
Event parameterid:Identifierhas_fixed_value:Fixed value flagfixed_value:Fixed value
Event parameters[element]:Event parameter
0..*
check Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Event parameter elements.
Creating elements in this collection is not supported.
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/network/notifications/events/:event/parameters/"
⇒
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 419
[{"fixed_value":null,"has_fixed_value":false,"id":"network_device"},{"fixed_value ←↩↪→ ":null,"has_fixed_value":false,"id":"network_link_id"},{"fixed_value":false ←↩↪→ ,"has_fixed_value":true,"id":"network_up"}]
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/network/notifications/events/'+ ←↩↪→ _event+'/parameters/',auth=auth,headers=headers).json())
⇒[{'fixed_value': None, 'has_fixed_value': False, 'id': 'network_device'}, {' ←↩
↪→ fixed_value': None, 'has_fixed_value': False, 'id': 'network_link_id'}, {' ←↩↪→ fixed_value': True, 'has_fixed_value': True, 'id': 'network_up'}]
Browse more samples
See also Event parameters: Event parameter
6 Event notification server object
object notification/
Object representing the event notification server configuration
Sinks[element]:Sink
Administrative userAdministratorRegular user
can_read,can_write
Protect notification settingsProtectedNot protectedProtect sender configuration
can_write
Rules[element]:Rule
can_read,can_write
can_write
Sink types[element]:Sink type
can_read
check,can_read,can_write,secret,can_index
Sink data item groups[element]:Sink data item group
can_read
secret,can_write,can_read,can_index,check
Event notification server objectsinks:Sinksrules:Rulesknown_sink_types:Sink typessink_data_item_groups:Sink data item groups
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
sinks Sinksrules Rulesknown_sink_types Sink types
sink_data_item_groups Sink data item groups
DLI V222 Object Model Reference: 20210317T201932Z
420 CONTENTS
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/notification/',auth=auth,headers ←↩↪→ =headers).json())
⇒<...>
Sample uom library write command:
uom.notification=<...>
Browse more samples
6.1 Sinks
array notification/sinks/
Sink array
Sinkname:Nametype:Typedata:Datatest:Test
Administrative userAdministratorRegular user
can_readSinks
[element]:Sink
0..*
can_read,can_write
Protect notification settingsProtectedNot protectedProtect sender configuration
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect notification settings
This array represents a value in persistent storage.
This array contains Sink elements.
Sample curl read command:
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 421
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/notification/sinks/"
⇒...
Sample CLI write command:
uom set "notification/sinks" "[{\"test\":{\"1\":{\"value\":\"function\"},\" ←↩↪→ results\":[\"Sink handler indicates notification failure, check log for ←↩↪→ errors\"],\"arguments\":[]},\"type\":\"snmpv2c\",\"name\":\"edward\",\"data ←↩↪→ \":{\"trap_oid\":\"2.711,,,\",\"server\":\"8joibc.pi9c2.b3z3tg.example.com ←↩↪→ \",\"community\":\"\"}},{\"test\":{\"1\":{\"value\":\"function\"},\"results ←↩↪→ \":[\"Sink handler indicates notification failure, check log for errors ←↩↪→ \"],\"arguments\":[]},\"type\":\"xmpp\",\"name\":\"william\",\"data\":{\" ←↩↪→ password\":\"bUt\\\"\",\"sender\":\"[email protected]\",\"recipient ←↩↪→ \":\"[email protected]\"}}]"
Browse more samples
6.1.1 Sink
object notification/sinks/N/
Event sink
Data[element]:Data item
Administrative userAdministratorRegular user
can_read,can_write
Protect notification settingsProtectedNot protectedProtect sender configuration
can_write
Sinkname:Nametype:Typedata:Data
test () -> ( Notification status )
can_read
Retrieving the value is denied if not administrative user
This object represents a value in persistent storage.
This object contains the following items:
name Nametype Type
data Datatest Test
Sample uom library deletion command (note that _sink_index is a variable):
uom.remove(uom.notification.sinks,_sink_index)
DLI V222 Object Model Reference: 20210317T201932Z
422 CONTENTS
Sample requests write command (note that _sink_index is a variable):
requests.put('http://192.168.0.100/restapi/notification/sinks/'+str(_sink_index) ←↩↪→ +'/',auth=auth,headers=headers,json={'test': [{'value': 'function'}], 'type ←↩↪→ ': 'snmpv3', 'name': 'kevin', 'data': {'security_engine_id': '0x6d', ' ←↩↪→ context_engine_id': '', 'auth_protocol': '', 'priv_protocol': 'DES', ' ←↩↪→ priv_passphrase': '', 'auth_passphrase': '', 'context_name': 'xe', ' ←↩↪→ security_name': 'william', 'trap_oid': '2.05,', 'server': 'w63b.zz3k.aynx. ←↩↪→ example.com'}})
Browse more samples
See also Sink: Name
See also Sink: Type
See also Sink: Data
See also Sink: Test
6.2 Sink: Name
string notification/sinks/N/name/
Sink name (can be shared between sinks)
Name
Administrative userAdministratorRegular user
can_read,can_write
Protect notification settingsProtectedNot protectedProtect sender configuration
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect notification settings
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 423
This string represents a value in persistent storage.
Sample CLI write command (note that sink_index is a variable):
uom set "notification/sinks/${sink_index}/name" "\"donald\""
Sample uom library read command (note that _sink_index is a variable):
print(uom.dump(uom.notification.sinks[_sink_index].name))
⇒"robert"
Browse more samples
6.3 Sink: Type
string notification/sinks/N/type/
Sink type
Type
can_read,check,can_write,secret,can_index
Administrative userAdministratorRegular user
can_read,can_write
Protect notification settingsProtectedNot protectedProtect sender configuration
can_write
Sink types[element]:Sink type
check
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:
• not administrative user
• protect notification settings
DLI V222 Object Model Reference: 20210317T201932Z
424 CONTENTS
This string represents a value in persistent storage.
Sample JS request write command (note that _sink_index is a variable):
request.put({url:"notification/sinks/"+_sink_index.toString()+"/type/",body:" ←↩↪→ snmpv1"});
Sample uom library write command (note that _sink_index is a variable):
uom.notification.sinks[_sink_index].type="snmpv3i"
Browse more samples
6.4 Sink: Data
map notification/sinks/N/data/
Sink-type-specific data
Data[element]:Data item
Administrative userAdministratorRegular user
can_read,can_write
Protect notification settingsProtectedNot protectedProtect sender configuration
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect notification settings
This map represents a value in persistent storage.
This map contains Data item elements.
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/data/"
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 425
⇒
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 "{\"security_engine_id ←↩↪→ \":\"0x8Dfb\",\"context_engine_id\":\"0x29\",\"auth_protocol\":\"SHA\",\" ←↩↪→ priv_protocol\":\"DES\",\"priv_passphrase\":\"\",\"auth_passphrase\":\"=9T ←↩↪→ zTIg\",\"context_name\":\"J\",\"security_name\":\"mark\",\"trap_oid ←↩↪→ \":\"2.2765,\",\"server\":\"oaq9rv.example.com\"}" "http://192.168.0.100/ ←↩↪→ restapi/notification/sinks/:sink_index/data/"
Browse more samples
6.4.1 Data item
string notification/sinks/N/data/S/
Item of sink-type-specific data
Data item
can_read:index,secret:index,can_write:index,can_index:index
Sink data item groups[element]:Sink data item group
secret,can_write,can_read,can_index
Sink types[element]:Sink type
can_read,check,can_write,secret,can_index
Type
can_read,check,can_write,secret,can_index
Administrative userAdministratorRegular user
can_write,can_read,can_index
The value is subject to the following constraints: the value matches sink types[type].data_items[index of thevalue].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
DLI V222 Object Model Reference: 20210317T201932Z
426 CONTENTS
• 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 requests write command (note that _sink_index and _data_item are variables):
requests.put('http://192.168.0.100/restapi/notification/sinks/'+str(_sink_index) ←↩↪→ +'/data/'+_data_item+'/',auth=auth,headers=headers,json='1681811')
Sample requests deletion command (note that _sink_index and _data_item are variables):
requests.delete('http://192.168.0.100/restapi/notification/sinks/'+str( ←↩↪→ _sink_index)+'/data/'+_data_item+'/',auth=auth,headers=headers)
Browse more samples
6.5 Sink: Test
call notification/sinks/N/test/Send a test notification using this sink
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 427
Test Administrative userAdministratorRegular user
can_invoke
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 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/"
⇒true
Sample uom library invocation (note that _sink_index is a variable):
print(uom.dump(uom.notification.sinks[_sink_index].test()))
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
428 CONTENTS
6.5.1 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 succeededstring Failure The notification has failed with the following error
6.6 Rules
array notification/rules/
Event processing rule list
Rulecondition:Rule conditionaction:Rule action
Administrative userAdministratorRegular user
can_readRules
[element]:Rule
0..*
can_read,can_write
Protect notification settingsProtectedNot protectedProtect sender configuration
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect notification settings
This array represents a value in persistent storage.
This array contains Rule elements.
Sample CLI read command:
uom get "notification/rules"
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 429
⇒
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/notification/rules/"
⇒[{"condition":"severity>=DEBUG","action":"notify(\"william\")"}]
Browse more samples
See also Rules: Rule
6.7 Rules: Rule
object notification/rules/N/
Event processing rule
Rulecondition:Rule conditionaction:Rule action
Administrative userAdministratorRegular user
can_read
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 conditionaction Rule 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>=DEBUG","action":"notify(\"jason\")"}
Sample uom library deletion command (note that _rule_index is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
430 CONTENTS
uom.remove(uom.notification.rules,_rule_index)
Browse more samples
6.7.1 Rule condition
string notification/rules/N/condition/
Lua expression to evaluate for events to be matched
Rule condition
Administrative userAdministratorRegular user
can_read,can_write
Protect notification settingsProtectedNot protectedProtect sender configuration
can_write
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:
• not administrative user
• protect notification settings
This string represents a value in persistent storage.
Sample curl write command (note that :rule_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 "\"severity>=NOTICE\"" " ←↩↪→ http://192.168.0.100/restapi/notification/rules/:rule_index/condition/"
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>=ALERT"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 431
6.7.2 Rule action
string notification/rules/N/action/
Lua code to evaluate for matching events
Rule action
Administrative userAdministratorRegular user
can_read,can_write
Protect notification settingsProtectedNot protectedProtect sender configuration
can_write
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:
• not administrative user
• protect notification settings
This string represents a value in persistent storage.
Sample JS request write command (note that _rule_index is a variable):
request.put({url:"notification/rules/"+_rule_index.toString()+"/action/",body:" ←↩↪→ notify(\"donald\")"});
Sample requests read command (note that _rule_index is a variable):
print(requests.get('http://192.168.0.100/restapi/notification/rules/'+str( ←↩↪→ _rule_index)+'/action/',auth=auth,headers=headers).json())
⇒'notify("michael")'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
432 CONTENTS
6.8 Sink types
map notification/known_sink_types/
Known sink types
Sink typename:Namedata_items:Supported data items
Administrative userAdministratorRegular user
can_readSink types
[element]:Sink type
0..*
can_read
check,can_read,can_write,secret,can_index
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 requests read command:
print(requests.get('http://192.168.0.100/restapi/notification/known_sink_types/', ←↩↪→ auth=auth,headers=headers).json())
⇒<...>
Sample CLI read command:
uom get "notification/known_sink_types"
⇒...
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 433
6.8.1 Sink type
object notification/known_sink_types/S/
Type of sink
Supported data items[element]:Data item properties
Administrative userAdministratorRegular user
can_readSink type
name:Namedata_items:Supported data items
can_read
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 Namedata_items Supported data items
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 v2c ←↩↪→ inform\",\"data_items\":{\"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\"}}}" "http://192.168.0.100/restapi/notification/ ←↩↪→ known_sink_types/:sink_type/"
Sample curl read command (note that :sink_type is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/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?://.*$"}}}
Browse more samples
See also Sink type: Name
See also Sink type: Supported data items
DLI V222 Object Model Reference: 20210317T201932Z
434 CONTENTS
6.9 Sink type: Name
string notification/known_sink_types/S/name/
Sink type name
Name Administrative userAdministratorRegular user
can_read
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 uom library read command (note that _sink_type is a variable):
print(uom.dump(uom.notification.known_sink_types[_sink_type].name))
⇒"XMPP (Jabber)"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 435
6.10 Sink type: Supported data items
map notification/known_sink_types/S/data_items/
Properties of supported data items
Data item propertiesname:Namegroup:Data item groupregexp:Regular expression
Supported data items[element]:Data item properties
0..*
Administrative userAdministratorRegular user
can_read
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":{"group":"msgkey"," ←↩↪→ name":"Community string","regexp":"^.*$"}}
Sample uom library read command (note that _sink_type is a variable):
print(uom.dump(uom.notification.known_sink_types[_sink_type].data_items))
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
436 CONTENTS
6.10.1 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 Namegroup 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":"Authentication protocol","regexp":"^(|MD5|SHA)$"}
Sample JS request write command (note that _sink_type and _data_item_properties arevariables):
request.put({url:"notification/known_sink_types/"+_sink_type+"/data_items/"+ ←↩↪→ _data_item_properties+"/",body:{"group":"msg","name":"Privacy protocol"," ←↩↪→ regexp":"^(|DES|AES)$"}});
Browse more samples
6.10.1.1 Name
string notification/known_sink_types/S/data_items/S/name/
Data item name
Name Administrative userAdministratorRegular user
can_read
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 437
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"
⇒"Content type"
Sample JS request read command (note that _sink_type and _data_item_properties arevariables):
request.get({url:"notification/known_sink_types/"+_sink_type+"/data_items/"+ ←↩↪→ _data_item_properties+"/name/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒"Privacy passphrase"
Browse more samples
6.10.1.2 Data item group
string notification/known_sink_types/S/data_items/S/group/
The group of data items to which this one belongs
Data item group
Sink data item groups[element]:Sink data item group
check
Administrative userAdministratorRegular user
can_read
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.
DLI V222 Object Model Reference: 20210317T201932Z
438 CONTENTS
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}/group"
⇒"msg"
Sample JS request read command (note that _sink_type and _data_item_properties arevariables):
request.get({url:"notification/known_sink_types/"+_sink_type+"/data_items/"+ ←↩↪→ _data_item_properties+"/group/"},function(error,response,body) {console.log ←↩↪→ (body)});
⇒"rcpt"
Browse more samples
6.10.1.3 Regular expression
string notification/known_sink_types/S/data_items/S/regexp/
Regular expression which the data item must match
Regular expression Administrative userAdministratorRegular user
can_read
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 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())
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 439
⇒'^[012](\\.[0-9]{1,}),{1,}$'
Sample JS request read command (note that _sink_type and _data_item_properties arevariables):
request.get({url:"notification/known_sink_types/"+_sink_type+"/data_items/"+ ←↩↪→ _data_item_properties+"/regexp/"},function(error,response,body) {console. ←↩↪→ log(body)});
⇒"^.*$"
Browse more samples
6.11 Sink data item groups
map notification/sink_data_item_groups/
Properties of groups of sink data items
Sink data item groupname:Namesecret:Secretimmutable:Immutableunreadable:Unreadable
Administrative userAdministratorRegular user
can_readSink data item groups
[element]:Sink data item group
0..*
can_read
secret,can_write,can_read,can_index,check
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)});
DLI V222 Object Model Reference: 20210317T201932Z
440 CONTENTS
⇒
Sample CLI read command:
uom get "notification/sink_data_item_groups"
⇒
Browse more samples
See also Sink data item groups: Sink data item group
6.12 Sink data item groups: Sink data item group
object notification/sink_data_item_groups/S/
Properties of a group of sink data items
Sink data item groupname:Namesecret:Secretimmutable:Immutableunreadable:Unreadable
Administrative userAdministratorRegular user
can_read
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 Namesecret Secretimmutable Immutableunreadable Unreadable
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="Recipient key",secret=true,unreadable=false}
Sample curl read command (note that :sink_data_item_group is a URL template argument):
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 441
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,"unreadable":false,"name":"Recipient key","secret":true}
Browse more samples
6.12.1 Name
string notification/sink_data_item_groups/S/name/
Data item group name
Name Administrative userAdministratorRegular user
can_read
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_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 attribute"
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+'/name/',auth=auth,headers= ←↩↪→ headers).json())
⇒'Recipient key'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
442 CONTENTS
6.12.2 Secret
sum (boolean) notification/sink_data_item_groups/S/secret/
Flag indicating whether the data item can contain private information
SecretSecretNot secret
Administrative userAdministratorRegular user
can_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 Secret The data item can contain private information
constant false Not secret The data item contains only public information
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+"/ ←↩↪→ secret/"},function(error,response,body) {console.log(body)});
⇒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())
⇒False
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
6 Event notification server object 443
6.12.3 Immutable
sum (boolean) notification/sink_data_item_groups/S/immutable/
Flag indicating whether the data item is not permitted to be changed
ImmutableImmutableNot immutable
Administrative userAdministratorRegular user
can_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 Immutable The data item is not permitted to be changed
constant false Not immutable The data item can be changed
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
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+'/immutable/',auth=auth, ←↩↪→ headers=headers).json())
⇒False
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
444 CONTENTS
6.12.4 Unreadable
sum (boolean) notification/sink_data_item_groups/S/unreadable/
Flag indicating whether the data item is not permitted to be read
UnreadableUnreadableNot unreadable
Administrative userAdministratorRegular user
can_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 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
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
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 445
7 Autoping server object
object autoping/
Object representing the autoping server state and configuration
Items[element]:Autoping item data
Administrative userAdministratorRegular user
can_read,can_write
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
Autoping server objectenabled:Enableditems:Itemsping_interval:Ping intervalping_timeout:Ping timeoutpost_reboot_delay:Post-reboot delaymax_reboot_count:Default maximum total reboot count, if anymax_consecutive_reboot_count:Default maximum consecutive reboot count, if anypings_before_enabling:Pings before enablingresume_without_retrial:Resume without retrialhandle_failures_immediately:Handle failures immediately
reset_statistics () -> ( Empty result )
notifications:Notifications
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
enabled Enableditems Itemsping_interval Ping interval
ping_timeout Ping timeout
post_reboot_delay Post-reboot delay
max_reboot_count Default maximum total reboot count, if any
max_consecutive_reboot_count Default maximum consecutive reboot count, if any
pings_before_enabling Pings before enabling
resume_without_retrial Resume without retrialhandle_failures_immediately Handle failures immediately
reset_statistics Reset statisticsnotifications Notifications
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/autoping/"
Sample uom library write command:
uom.autoping=<...>
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
446 CONTENTS
7.1 Enabled
sum (boolean) autoping/enabled/
Autoping global enable status
EnabledEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample uom library write command:
uom.autoping.enabled=false
Sample JS request read command:
request.get({url:"autoping/enabled/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 447
7.2 Items
array autoping/items/
Autoping item list
Autoping item dataenabled:Enabled statusaddresses:Address listoutlets:Controlled outletsscript:Script command, if anyenable:Request item state changestatus:Autoping item statuspings_before_enabling:Pings remaining to enable, if anyrecently_failed:Recently failedresumption_trial:In resumption trial
Administrative userAdministratorRegular user
can_readItems
[element]:Autoping item data0..*
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array represents a value in persistent storage.
This array contains Autoping item data elements.
Sample uom library write command:
uom.autoping.items={{addresses={"tcp://6.110.183.242:39318"},outlets={},script=" ←↩↪→ energize_heaters",status={hosts={},reboots=0}},{addresses={"98.251.92.6"," ←↩↪→ tcp://sn4jNuf3E.D0VIg6.example.com:63707","5.8.8.2"},enabled=false,outlets ←↩↪→ ={},pings_before_enabling=null,script="toggle_gadget"}}
Sample CLI write command:
uom set "autoping/items" ...
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
448 CONTENTS
7.2.1 Autoping item data
object autoping/items/N/
Data related to autoping item state and configuration
Address list[element]:Address
check
Administrative userAdministratorRegular user
can_read,can_write
Controlled outlets[element]:Outlet index
can_read,can_writecheck
Autoping item statushosts:Target statesreboots:Reboot count
can_read
Autoping item dataenabled:Enabled statusaddresses:Address listoutlets:Controlled outletsscript:Script command, if any
enable ( Desired item state ) -> ( Empty result )
status:Autoping item statuspings_before_enabling:Pings remaining to enable, if anyrecently_failed:Recently failedresumption_trial:In resumption trial
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
enabled Enabled statusaddresses Address listoutlets Controlled outletsscript Script command, if any
enable Request item state change
status Autoping item status
pings_before_enabling Pings remaining to enable, if any
recently_failed Recently failed
resumption_trial In resumption trial
Sample curl deletion command (note that :autoping_item_data_index is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X DELETE -H "Accept: application/json ←↩↪→ " "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/"
Sample uom library write command (note that _autoping_item_data_index is a variable):
uom.autoping.items[_autoping_item_data_index]={addresses={"http://38.2.1.238"}, ←↩↪→ enabled=false,outlets={1,5,7},pings_before_enabling=null,script=" ←↩↪→ energize_contraptions",status={hosts={},reboots=0}}
Browse more samples
See also Autoping item data: Enabled status
See also Autoping item data: Address list
See also Autoping item data: Controlled outlets
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 449
See also Autoping item data: Script command, if any
See also Autoping item data: Request item state change
See also Autoping item data: Autoping item status
See also Autoping item data: Pings remaining to enable, if any
See also Autoping item data: Recently failed
See also Autoping item data: In resumption trial
7.3 Autoping item data: Enabled status
sum (boolean) autoping/items/N/enabled/
Whether this item is enabled (can be triggered)
Enabled statusEnabledDisabled
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum represents a value in persistent storage.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample requests read command (note that _autoping_item_data_index is a variable):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str( ←↩↪→ _autoping_item_data_index)+'/enabled/',auth=auth,headers=headers).json())
⇒
DLI V222 Object Model Reference: 20210317T201932Z
450 CONTENTS
False
Sample JS request read command (note that _autoping_item_data_index is a variable):
request.get({url:"autoping/items/"+_autoping_item_data_index.toString()+"/enabled ←↩↪→ /"},function(error,response,body) {console.log(body)});
⇒false
Browse more samples
7.4 Autoping item data: Address list
array autoping/items/N/addresses/
List of addresses to ping
Address list[element]:Address
check
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be suppliedmore than once).
This array contains Address elements.
Sample JS request address creation command (note that _autoping_item_data_index is a variable):
request.post({url:"autoping/items/"+_autoping_item_data_index.toString()+"/ ←↩↪→ addresses/",body:"https://214.217.73.73/mujgpj9hG7I/nnDk50"});
Sample CLI address creation command (note that autoping_item_data_index is a variable):
uom insert "autoping/items/${autoping_item_data_index}/addresses/0" "\"http:// ←↩↪→ uSx2.example.com:38449/HNrC/EZdp/o1y.p/nGgLMZm/sNSAm/e8eDoU\""
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 451
7.4.1 Address
string autoping/items/N/addresses/N/
URL to ping (default schema is icmp)
Address
Address list[element]:Address
check
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: address list are distinct
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
Sample CLI write command (note that autoping_item_data_index and address_index arevariables):
uom set "autoping/items/${autoping_item_data_index}/addresses/${address_index}" ←↩↪→ "\"tcp://86.51.222.164:285\""
Sample curl deletion command (note that :autoping_item_data_index and :address_index areURL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X DELETE -H "Accept: application/json ←↩↪→ " "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/ ←↩↪→ addresses/:address_index/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
452 CONTENTS
7.5 Autoping item data: Controlled outlets
array autoping/items/N/outlets/
List of outlets to perform specified action on
Controlled outlets[element]:Outlet index
check
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be suppliedmore than once).
This array contains Outlet index elements.
Sample CLI outlet index creation command (note that autoping_item_data_index is a variable):
uom insert "autoping/items/${autoping_item_data_index}/outlets/2" "5"
Sample requests outlet index creation command (note that _autoping_item_data_index is a variable):
requests.post('http://192.168.0.100/restapi/autoping/items/'+str( ←↩↪→ _autoping_item_data_index)+'/outlets/',auth=auth,headers=headers,json=0)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 453
7.5.1 Outlet index
number autoping/items/N/outlets/N/
Index of outlet to perform action on
Outlet index
Administrative userAdministratorRegular user
can_read,can_write
Controlled outlets[element]:Outlet index
check
Outlets[element]:Outlet
check
The value is subject to the following constraints: all of the following is true:
• outlets[the value]
• controlled outlets are distinct
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number represents a value in persistent storage.
Sample curl write command (note that :autoping_item_data_index and :outlet_index_indexare URL template arguments):
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/autoping/items/:autoping_item_data_index/outlets/: ←↩↪→ outlet_index_index/"
Sample uom library deletion command (note that _autoping_item_data_index and _outlet_index←↩
_index are variables):
local composite=uom.copy(uom.autoping.items[_autoping_item_data_index].outlets)uom.remove(composite,_outlet_index_index)uom.autoping.items[_autoping_item_data_index].outlets=composite
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
454 CONTENTS
7.6 Autoping item data: Script command, if any
sum (string) autoping/items/N/script/
Action to perform on selected outlets on failure, or cycle them if empty
Script command, if anyScript commandInvalid action placeholderCycle outlets
Administrative userAdministratorRegular user
can_read,can_write
User functions[element]:User script function signature
check
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
string Script command Action to perform on selectedoutlets on failure
all of the following is true:
• not the value matches∧(|.∗|.∗)$
• user functions[the value]
string Invalid action placeholder A placeholder for a failure ac-tion that has been deleted or re-named (has no effect other thanlogging a warning)
the value matches ∧autoping_←↩
deleted:.∗$
constant "" Cycle outlets Selected outlets are to be cycled on failure
Sample uom library write command (note that _autoping_item_data_index is a variable):
uom.autoping.items[_autoping_item_data_index].script=""
Sample JS request read command (note that _autoping_item_data_index is a variable):
request.get({url:"autoping/items/"+_autoping_item_data_index.toString()+"/script ←↩↪→ /"},function(error,response,body) {console.log(body)});
⇒""
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 455
7.7 Autoping item data: Request item state change
call autoping/items/N/enable/
Request the item to enter enabled or disabled status. Disabled status is entered immediately. If the item isdisabled, enabling it is not immediate (takes a trial period).
Request item state change Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if not administrative user
The call accepts the following arguments:
1. Desired item state: Enabled or Disabled
The call returns the following results:
1. Empty result: null
Sample CLI invocation (note that autoping_item_data_index is a variable):
uom invoke "autoping/items/${autoping_item_data_index}/enable" "true"
⇒(no output)
Sample curl invocation (note that :autoping_item_data_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 "[false]" "http://192.168.0.100/ ←↩↪→ restapi/autoping/items/:autoping_item_data_index/enable/"
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
456 CONTENTS
7.7.1 Desired item state
sum (boolean) autoping/items/N/enable/arguments: 1/
The state you request the item to switch to
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
7.7.2 Empty result
constant null autoping/items/N/enable/results: 1/
No additional information available
This constant does not correspond to an actual resource.
7.8 Target states: Target state
object autoping/items/N/status/hosts/N/
State of a target subjected to ping
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
address Addressstate Statestate_details State details, if any
success_count Success countfailure_count Failure countqueue_size Queue size
Sample uom library write command (note that _autoping_item_data_index and _target_state_←↩
index are variables):
uom.autoping.items[_autoping_item_data_index].status.hosts[_target_state_index]={ ←↩↪→ address="90.211.206.251",failure_count=565,queue_size=2,state=null, ←↩↪→ state_details="Something strange and unexpected has happened to ←↩↪→ 90.211.206.251",success_count=0}
Sample requests write command (note that _autoping_item_data_index and _target_state_←↩
index are variables):
requests.put('http://192.168.0.100/restapi/autoping/items/'+str( ←↩↪→ _autoping_item_data_index)+'/status/hosts/'+str(_target_state_index)+'/', ←↩↪→ auth=auth,headers=headers,json={'state': None, 'success_count': 0, 'address ←↩
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 457
↪→ ': 'http://4Isj.dv69.bl3fjLG.xYsAZgGgw1lF.lf8hmH.example.com:61002', ' ←↩↪→ state_details': 'Something strange and unexpected has happened to http://4 ←↩↪→ Isj.dv69.bl3fjLG.xYsAZgGgw1lF.lf8hmH.example.com:61002', 'failure_count': ←↩↪→ 0, 'queue_size': 3})
Browse more samples
7.8.1 Address
string autoping/items/N/status/hosts/N/address/
Address that is being checked (default schema is icmp)
Address Target states[element]:Target state
check
The value is subject to the following constraints: address members of all values of target states are distinct
This string is a part of a composite value which is modified as a whole.
This string does not support direct modification.
This string can change as if by itself or indirectly because of other actions.
Changes to this string cannot be tracked.
Sample uom library read command (note that _autoping_item_data_index and _target_state_←↩
index are variables):
print(uom.dump(uom.autoping.items[_autoping_item_data_index].status.hosts[ ←↩↪→ _target_state_index].address))
⇒"https://nJcmRze.aRyyC.ScpbBk.aWEf.wbmZND.example.com"
Sample curl read command (note that :autoping_item_data_index and :target_state_indexare URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/autoping/items/:autoping_item_data_index/status/hosts/: ←↩↪→ target_state_index/address/"
⇒"https://92.76.105.251/6mj7Jqi1/.ByLuatNggRB/u8duMt/fte.kN"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
458 CONTENTS
7.8.2 State
sum (optional boolean) autoping/items/N/status/hosts/N/state/
Target perceived state
StateOnlineOfflineUnknown
Administrative userAdministratorRegular user
can_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 change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant true Online The target is responding to ping requests
constant false Offline The target is not responding to ping requests
constant null Unknown Not enough information about target state
Sample JS request read command (note that _autoping_item_data_index and _target_state_←↩
index are variables):
request.get({url:"autoping/items/"+_autoping_item_data_index.toString()+"/status/ ←↩↪→ hosts/"+_target_state_index.toString()+"/state/"},function(error,response, ←↩↪→ body) {console.log(body)});
⇒
null
Sample requests read command (note that _autoping_item_data_index and _target_state_←↩
index are variables):
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 459
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str( ←↩↪→ _autoping_item_data_index)+'/status/hosts/'+str(_target_state_index)+'/ ←↩↪→ state/',auth=auth,headers=headers).json())
⇒None
Browse more samples
7.8.3 State details, if any
sum (optional string) autoping/items/N/status/hosts/N/state_details/
Additional information of target state, if any
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 change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant null No details No additional information availablestring State details Additional information of target state
Sample uom library read command (note that _autoping_item_data_index and _target_state_←↩
index are variables):
print(uom.dump(uom.autoping.items[_autoping_item_data_index].status.hosts[ ←↩↪→ _target_state_index].state_details))
⇒null
Sample JS request read command (note that _autoping_item_data_index and _target_state_←↩
index are variables):
request.get({url:"autoping/items/"+_autoping_item_data_index.toString()+"/status/ ←↩↪→ hosts/"+_target_state_index.toString()+"/state_details/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒"tcp://6PUn6gBUif4N.tqAMz.jqqGLz.example.com:39248 returned the following error"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
460 CONTENTS
7.8.4 Success count
number autoping/items/N/status/hosts/N/success_count/
Number of times this target has responded to a ping request in time
Success count Administrative userAdministratorRegular user
can_read
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
Retrieving the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number does not support direct modification.
This number can change as if by itself or indirectly because of other actions.
Changes to this number cannot be tracked.
Sample CLI read command (note that autoping_item_data_index and target_state_index arevariables):
uom get "autoping/items/${autoping_item_data_index}/status/hosts/${ ←↩↪→ target_state_index}/success_count"
⇒5363
Sample curl read command (note that :autoping_item_data_index and :target_state_indexare URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/autoping/items/:autoping_item_data_index/status/hosts/: ←↩↪→ target_state_index/success_count/"
⇒0
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 461
7.8.5 Failure count
number autoping/items/N/status/hosts/N/failure_count/
Number of times this target has failed to respond to a ping request in time
Failure count Administrative userAdministratorRegular user
can_read
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
Retrieving the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number does not support direct modification.
This number can change as if by itself or indirectly because of other actions.
Changes to this number cannot be tracked.
Sample CLI read command (note that autoping_item_data_index and target_state_index arevariables):
uom get "autoping/items/${autoping_item_data_index}/status/hosts/${ ←↩↪→ target_state_index}/failure_count"
⇒421
Sample requests read command (note that _autoping_item_data_index and _target_state_←↩
index are variables):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str( ←↩↪→ _autoping_item_data_index)+'/status/hosts/'+str(_target_state_index)+'/ ←↩↪→ failure_count/',auth=auth,headers=headers).json())
⇒0
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
462 CONTENTS
7.8.6 Queue size
number autoping/items/N/status/hosts/N/queue_size/
Number of ping requests to which no replies have yet been received (0 if the parent ping item is not enabled)
Queue size Administrative userAdministratorRegular user
can_read
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
Retrieving the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number does not support direct modification.
This number can change as if by itself or indirectly because of other actions.
Changes to this number cannot be tracked.
Sample CLI read command (note that autoping_item_data_index and target_state_index arevariables):
uom get "autoping/items/${autoping_item_data_index}/status/hosts/${ ←↩↪→ target_state_index}/queue_size"
⇒3
Sample JS request read command (note that _autoping_item_data_index and _target_state_←↩
index are variables):
request.get({url:"autoping/items/"+_autoping_item_data_index.toString()+"/status/ ←↩↪→ hosts/"+_target_state_index.toString()+"/queue_size/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒0
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 463
7.9 Autoping item data: Autoping item status
object autoping/items/N/status/
Information on monitored target status and reboots
Target states[element]:Target state
checkAdministrative userAdministratorRegular user
can_readAutoping item statushosts:Target statesreboots:Reboot count
can_read
The value is unconditionally set to {"reboots":0,"hosts":[]} on creation and doesn't have to be supplied(if it is, it must match)
Retrieving the value is denied if not administrative user
This object is composite, i.e. is modified as a whole.
This object does not support direct modification.
This object can change as if by itself or indirectly because of other actions.
Changes to this object cannot be tracked.
This object contains the following items:
hosts Target states
reboots Reboot count
Sample uom library read command (note that _autoping_item_data_index is a variable):
print(uom.dump(uom.autoping.items[_autoping_item_data_index].status))
⇒
Sample curl read command (note that :autoping_item_data_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/autoping/items/:autoping_item_data_index/status/"
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
464 CONTENTS
7.9.1 Target states
array autoping/items/N/status/hosts/
States of targets associated with this item
Target stateaddress:Addressstate:Statestate_details:State details, if anysuccess_count:Success countfailure_count:Failure countqueue_size:Queue size
Target states[element]:Target state
0..*
check Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array can change as if by itself or indirectly because of other actions.
Changes to this array cannot be tracked.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be suppliedmore than once).
This array contains Target state elements.
Creating elements in this collection is not supported.
Sample curl read command (note that :autoping_item_data_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/autoping/items/:autoping_item_data_index/status/hosts/"
⇒[{"state":null,"success_count":9074,"address":"tcp://jponR.s4XyqjRpXC.example.com ←↩
↪→ :62188","state_details":null,"failure_count":663,"queue_size":3}]
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 465
Sample requests read command (note that _autoping_item_data_index is a variable):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str( ←↩↪→ _autoping_item_data_index)+'/status/hosts/',auth=auth,headers=headers).json ←↩↪→ ())
⇒
Browse more samples
See also Target states: Target state
7.9.2 Reboot count
number autoping/items/N/status/reboots/
Number of times this item's action has been triggered
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
This number is a part of a composite value which is modified as a whole.
This number does not support direct modification.
This number can change as if by itself or indirectly because of other actions.
Changes to this number cannot be tracked.
Sample requests read command (note that _autoping_item_data_index is a variable):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str( ←↩↪→ _autoping_item_data_index)+'/status/reboots/',auth=auth,headers=headers). ←↩↪→ json())
⇒7
Sample JS request read command (note that _autoping_item_data_index is a variable):
request.get({url:"autoping/items/"+_autoping_item_data_index.toString()+"/status/ ←↩↪→ reboots/"},function(error,response,body) {console.log(body)});
⇒2
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
466 CONTENTS
7.10 Autoping item data: Pings remaining to enable, if any
sum (optional number) autoping/items/N/pings_before_enabling/
Estimate of number of successful ping replies remaining to enable the item, if any
Pings remaining to enable, if anyTrial period overPings remaining to enable
Administrative userAdministratorRegular user
can_read
The value is unconditionally set to null on creation and doesn't have to be supplied (if it is, it must match)
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant null Trial period over Item is no longer in the trial state (it is either enabledor disabled)
number Pings remaining to enable Estimate of successful pingreplies remaining to enablethe item (replies from targetswhich have already reachedthe enable threshold do notcount)
all of the following is true:
• the value is an integer
• the value is greater orequal to 0
Sample uom library read command (note that _autoping_item_data_index is a variable):
print(uom.dump(uom.autoping.items[_autoping_item_data_index]. ←↩↪→ pings_before_enabling))
⇒null
Sample CLI read command (note that autoping_item_data_index is a variable):
uom get "autoping/items/${autoping_item_data_index}/pings_before_enabling"
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 467
7.11 Autoping item data: Recently failed
sum (boolean) autoping/items/N/recently_failed/
Flag indicating whether this item has recently failed
Recently failedRecently failedNormal operation
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant true Recently failed The item has failed recently, and a new failure wouldbe counted as consecutive
constant false Normal operation The item is in normal operational state
Sample CLI read command (note that autoping_item_data_index is a variable):
uom get "autoping/items/${autoping_item_data_index}/recently_failed"
⇒[]
Sample uom library read command (note that _autoping_item_data_index is a variable):
print(uom.dump(uom.autoping.items[_autoping_item_data_index].recently_failed))
⇒{}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
468 CONTENTS
7.12 Autoping item data: In resumption trial
sum (boolean) autoping/items/N/resumption_trial/
Flag indicating whether this item is being tried after service restoration
In resumption trialIn resumption trialNormal operation
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant true In resumption trial Item is being tried after service restoration (failuresdon't cause it to trigger until the required amount ofrequests succeed)
constant false Normal operation The item is in normal operational state, and may betriggered by failures
Sample uom library read command (note that _autoping_item_data_index is a variable):
print(uom.dump(uom.autoping.items[_autoping_item_data_index].resumption_trial))
⇒{}
Sample CLI read command (note that autoping_item_data_index is a variable):
uom get "autoping/items/${autoping_item_data_index}/resumption_trial"
⇒[]
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 469
7.13 Ping interval
number autoping/ping_interval/
Interval between consecutive pings to the same address
Ping interval Administrative userAdministratorRegular user
can_read,can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample requests write command:
requests.put('http://192.168.0.100/restapi/autoping/ping_interval/',auth=auth, ←↩↪→ headers=headers,json=4)
Sample CLI write command:
uom set "autoping/ping_interval" "2"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
470 CONTENTS
7.14 Ping timeout
number autoping/ping_timeout/
Absence of response this long means the ping has timed out
Ping timeout Administrative userAdministratorRegular user
can_read,can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample JS request write command:
request.put({url:"autoping/ping_timeout/",body:138});
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/autoping/ping_timeout/"
⇒133
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 471
7.15 Post-reboot delay
number autoping/post_reboot_delay/
Time to wait after triggering the autoping action before pinging again
Post-reboot delay Administrative userAdministratorRegular user
can_read,can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/autoping/post_reboot_delay/', ←↩↪→ auth=auth,headers=headers).json())
⇒279
Sample JS request read command:
request.get({url:"autoping/post_reboot_delay/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒441
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
472 CONTENTS
7.16 Default maximum total reboot count, if any
sum (number) autoping/max_reboot_count/
Default maximum total number of times to perform the autoping action on an entry before giving up, if any
Default maximum total reboot count, if anyMaximum total reboot countRetry indefinitely
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
number Maximum total reboot count Maximum total number oftimes to perform the autopingaction on an entry before giv-ing up (counter does not getreset if response is received)
all of the following is true:
• the value is an integer
• the value is greater than0
constant 0 Retry indefinitely Perform the autoping action indefinitely no matter howmany reboot attempts yielded no response
Sample CLI read command:
uom get "autoping/max_reboot_count"
⇒6
Sample uom library write command:
uom.autoping.max_reboot_count=6
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 473
7.17 Default maximum consecutive reboot count, if any
sum (number) autoping/max_consecutive_reboot_count/
Default maximum consecutive number of times to perform the autoping action on an entry before giving up, ifany
Default maximum consecutive reboot count, if anyMaximum consecutive reboot countRetry indefinitely
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
number Maximum consecutive rebootcount
Maximum consecutive numberof times to perform the autop-ing action on an entry beforegiving up (counter gets reset ifresponse is received)
all of the following is true:
• the value is an integer
• the value is greater than0
constant 0 Retry indefinitely Perform the autoping action indefinitely no matterhow many consecutive reboot attempts yielded no re-sponse
Sample requests write command:
requests.put('http://192.168.0.100/restapi/autoping/max_consecutive_reboot_count ←↩↪→ /',auth=auth,headers=headers,json=32)
Sample uom library write command:
uom.autoping.max_consecutive_reboot_count=99
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
474 CONTENTS
7.18 Pings before enabling
number autoping/pings_before_enabling/
Minimum number of successful ping responses before enabling an autoping entry
Pings before enabling Administrative userAdministratorRegular user
can_read,can_write
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
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 "2" "http ←↩↪→ ://192.168.0.100/restapi/autoping/pings_before_enabling/"
Sample requests write command:
requests.put('http://192.168.0.100/restapi/autoping/pings_before_enabling/',auth= ←↩↪→ auth,headers=headers,json=2)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 475
7.19 Resume without retrial
sum (boolean) autoping/resume_without_retrial/
Activate enabled entries when service is restored without waiting for a certain number of successful ping re-sponses
Resume without retrialEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample uom library write command:
uom.autoping.resume_without_retrial=false
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 "true" "http ←↩↪→ ://192.168.0.100/restapi/autoping/resume_without_retrial/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
476 CONTENTS
7.20 Handle failures immediately
sum (boolean) autoping/handle_failures_immediately/
Detect and act upon explicit failures (e.g. TCP port closed response, HTTP 500, etc.) immediately instead ofwaiting for timeout
Handle failures immediatelyEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample CLI write command:
uom set "autoping/handle_failures_immediately" "false"
Sample JS request write command:
request.put({url:"autoping/handle_failures_immediately/",body:true});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 477
7.21 Reset statistics
call autoping/reset_statistics/
Clear the statistics (item success, failure and reboot counters)
Reset statistics Administrative userAdministratorRegular user
can_invoke
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. Empty result: null
Sample CLI invocation:
uom invoke "autoping/reset_statistics"
⇒(no output)
Sample requests invocation:
requests.post('http://192.168.0.100/restapi/autoping/reset_statistics/',auth=auth ←↩↪→ ,headers=headers,json={})
⇒(no output)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
478 CONTENTS
7.21.1 Empty result
constant null autoping/reset_statistics/results: 1/
No additional information available
This constant does not correspond to an actual resource.
7.22 Notifications
object autoping/notifications/
Autoping status notifications
Parameter kindsping_address:Addressping_state:Ping stateping_ping_time:Ping timeping_ping_timeout:Ping timeoutping_item_state:Item stateping_item_name:Item nameping_item_script_name:Item script nameping_item_addrs:Item addressesping_item_total_failure_count:Total failure countping_item_consecutive_failure_count:Consecutive failure countping_item_max_total_failure_count:Maximum total failure count, if anyping_item_max_consecutive_failure_count:Maximum consecutive failure count, if anyping_item_pings_before_enabling:Pings before enabling
check
Events[element]:Event
Administrative userAdministratorRegular user
can_read
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
Retrieving the value is denied if not administrative user
This object does not support direct modification.
This object contains the following items:
parameter_kinds Parameter kinds
events Events
Sample CLI read command:
uom get "autoping/notifications"
⇒...
Sample JS request read command:
request.get({url:"autoping/notifications/"},function(error,response,body) { ←↩↪→ console.log(body)});
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 479
⇒<...>
Browse more samples
See also Notifications: Parameter kinds
7.22.1 Events
map autoping/notifications/events/
Event templates
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
Events[element]:Event
0..*
Administrative userAdministratorRegular user
can_read
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 Event 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/autoping/notifications/events/"
⇒...
Sample CLI read command:
uom get "autoping/notifications/events"
⇒...
Browse more samples
See also Events: Event
DLI V222 Object Model Reference: 20210317T201932Z
480 CONTENTS
7.23 Notifications: Parameter kinds
object autoping/notifications/parameter_kinds/
Kinds of event parameters
This object does not correspond to an actual resource.
This object contains the following items:
ping_address Address
ping_state Ping state
ping_ping_time Ping time
ping_ping_timeout Ping timeout
ping_item_state Item state
ping_item_name Item name
ping_item_script_name Item script name
ping_item_addrs Item addresses
ping_item_total_failure_count Total failure count
ping_item_consecutive_failure_count Consecutive failure count
ping_item_max_total_failure_count Maximum total failure count, if any
ping_item_max_consecutive_failure_count Maximum consecutive failure count, if any
ping_item_pings_before_enabling Pings before enabling
7.23.1 Address
string autoping/notifications/parameter_kinds/ping_address/
Address of ping target
7.23.2 Ping state
sum (variant) autoping/notifications/parameter_kinds/ping_state/
State of the target ping request
This sum can assume the following values:
constant true Reachable The target has responded to the ping
constant false Unreachable The ping has timed out
constant "sent" Sent The ping has been sent but no response yet seen, andtimeout not reached
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 481
7.23.3 Ping time
number autoping/notifications/parameter_kinds/ping_ping_time/
The time it took to arrive at this ping state
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater or equal to 0
7.23.4 Ping timeout
number autoping/notifications/parameter_kinds/ping_ping_timeout/
The time after which the ping is considered unsuccessful if no response seen
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
7.23.5 Item state
sum (variant) autoping/notifications/parameter_kinds/ping_item_state/
State of the autoping item
This sum can assume the following values:
constant true Enabled The autoping item is enabled
constant false Disabled The autoping item is disabled
constant "enabling" Enabling The autoping item is in trial state
DLI V222 Object Model Reference: 20210317T201932Z
482 CONTENTS
7.23.6 Item name
string autoping/notifications/parameter_kinds/ping_item_name/
Name of the autoping item
7.23.7 Item script name
string autoping/notifications/parameter_kinds/ping_item_script_name/
Name of the scripting function associated with the autoping item
7.23.8 Item addresses
string autoping/notifications/parameter_kinds/ping_item_addrs/
Comma-separated list of addresses belonging to this item
7.23.9 Total failure count
number autoping/notifications/parameter_kinds/ping_item_total_failure_count/
Total number of times the item has failed
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 483
7.23.10 Consecutive failure count
number autoping/notifications/parameter_kinds/ping_item_consecutive_failure_count/
Number of times the item has failed consecutively
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
7.23.11 Maximum total failure count, if any
sum (optional number) autoping/notifications/parameter_kinds/ping_item_max_total_failure_count/
Number of total failures after which the item becomes disabled, if any
This sum can assume the following values:
constant null Retry indefinitely The action will be performed regardless of the numberof total failures
number Maximum total failure count Number of total failures afterwhich the item becomes dis-abled
all of the following is true:
• the value is an integer
• the value is greater orequal to 0
DLI V222 Object Model Reference: 20210317T201932Z
484 CONTENTS
7.23.12 Maximum consecutive failure count, if any
sum (optional number) autoping/notifications/parameter_kinds/ping_item_max_consecutive_failure_count/
Number of consecutive failures after which the item becomes disabled, if any
This sum can assume the following values:
constant null Retry indefinitely The action will be performed regardless of the numberof consecutive failures
number Maximum consecutive failurecount
Number of consecutive fail-ures after which the item be-comes disabled
all of the following is true:
• the value is an integer
• the value is greater orequal to 0
7.23.13 Pings before enabling
number autoping/notifications/parameter_kinds/ping_item_pings_before_enabling/
Number of successful pings left to enable the autoping item
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 485
7.24 Event parameters: Event parameter
object autoping/notifications/events/S/parameters/N/
Properties of a parameter associated with the event
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
id Identifierhas_fixed_value Fixed value flag
fixed_value Fixed value
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.autoping.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index]))
⇒{fixed_value=true,has_fixed_value=true,id="ping_item_state"}
Sample JS request read command (note that _event and _event_parameter_index are variables):
request.get({url:"autoping/notifications/events/"+_event+"/parameters/"+ ←↩↪→ _event_parameter_index.toString()+"/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒{"fixed_value":null,"has_fixed_value":false,"id":"ping_address"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
486 CONTENTS
7.24.1 Identifier
string autoping/notifications/events/S/parameters/N/id/
Parameter identifier
Identifier
Parameter kindsping_address:Addressping_state:Ping stateping_ping_time:Ping timeping_ping_timeout:Ping timeoutping_item_state:Item stateping_item_name:Item nameping_item_script_name:Item script nameping_item_addrs:Item addressesping_item_total_failure_count:Total failure countping_item_consecutive_failure_count:Consecutive failure countping_item_max_total_failure_count:Maximum total failure count, if anyping_item_max_consecutive_failure_count:Maximum consecutive failure count, if anyping_item_pings_before_enabling:Pings before enabling
check
Administrative userAdministratorRegular user
can_read
The value is subject to the following constraints: parameter kinds[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 _event and _event_parameter_index are variables):
request.get({url:"autoping/notifications/events/"+_event+"/parameters/"+ ←↩↪→ _event_parameter_index.toString()+"/id/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"ping_item_failure_count"
Sample requests read command (note that _event and _event_parameter_index are variables):
print(requests.get('http://192.168.0.100/restapi/autoping/notifications/events/'+ ←↩↪→ _event+'/parameters/'+str(_event_parameter_index)+'/id/',auth=auth,headers= ←↩↪→ headers).json())
⇒'ping_ping_time'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 487
7.24.2 Fixed value flag
sum (boolean) autoping/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
Fixed value flagFixedVariable
Administrative userAdministratorRegular user
can_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 Fixed The value is fixedconstant false Variable The value is variable
Sample JS request read command (note that _event and _event_parameter_index are variables):
request.get({url:"autoping/notifications/events/"+_event+"/parameters/"+ ←↩↪→ _event_parameter_index.toString()+"/has_fixed_value/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒false
Sample curl read command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/autoping/notifications/events/:event/parameters/: ←↩↪→ event_parameter_index/has_fixed_value/"
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
488 CONTENTS
7.24.3 Fixed value
sum (variant) autoping/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
Fixed valueNullTrueFalseStringNumber
Administrative userAdministratorRegular user
can_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 null Null Nullconstant true True Trueconstant false False Falsestring String This string
number Number This number
Sample CLI read command (note that event and event_parameter_index are variables):
uom get "autoping/notifications/events/${event}/parameters/${ ←↩↪→ event_parameter_index}/fixed_value"
⇒null
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.autoping.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].fixed_value))
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 489
⇒null
Browse more samples
7.25 Events: Event
object autoping/notifications/events/S/
Event template
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
can_readcheck
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
message_template Message template
severity Severity
parameters Event parameters
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/autoping/notifications/events/:event/"
⇒
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/autoping/notifications/events/'+ ←↩↪→ _event+'/',auth=auth,headers=headers).json())
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
490 CONTENTS
7.25.1 Message template
array autoping/notifications/events/S/message_template/
Template for human-readable message generation
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Message template element elements.
Creating elements in this collection is not supported.
Sample JS request read command (note that _event is a variable):
request.get({url:"autoping/notifications/events/"+_event+"/message_template/"}, ←↩↪→ function(error,response,body) {console.log(body)});
⇒["item ",0," (",1,") failed over ",2," times in a row, disabling"]
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/autoping/notifications/events/'+ ←↩↪→ _event+'/message_template/',auth=auth,headers=headers).json())
⇒['item ', 0, ' (', 1, ') enable cancelled (', 2, ' pings left)']
Browse more samples
7.25.1.1 Message template element
sum (variant) autoping/notifications/events/S/message_template/N/
Element of human-readable message template
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 491
Message template elementStringParameter
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
check
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:
string String Fixed string
number Parameter Index of message parameter to insert event parameters[the value]
Sample curl read command (note that :event and :message_template_element_index are URLtemplate arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/autoping/notifications/events/:event/message_template/: ←↩↪→ message_template_element_index/"
⇒0
Sample CLI read command (note that event and message_template_element_index are variables):
uom get "autoping/notifications/events/${event}/message_template/${ ←↩↪→ message_template_element_index}"
⇒0
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
492 CONTENTS
7.25.2 Severity
sum (enumerated number) autoping/notifications/events/S/severity/
Severity rating assigned to the event
SeverityEmergencyAlertCriticalErrorWarningNoticeInformationalDebug
Administrative userAdministratorRegular user
can_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 1 Emergency Treat the event as an emergency
constant 2 Alert Treat the event as an alertconstant 3 Critical Treat the event as criticalconstant 4 Error Treat the event as an errorconstant 5 Warning Treat the event as a warning
constant 6 Notice Treat the event as a noticeconstant 7 Informational Treat the event as informationalconstant 8 Debug Treat the event as debugging-related
Sample JS request read command (note that _event is a variable):
request.get({url:"autoping/notifications/events/"+_event+"/severity/"},function( ←↩↪→ error,response,body) {console.log(body)});
DLI V222 Object Model Reference: 20210317T201932Z
7 Autoping server object 493
⇒6
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/autoping/notifications/events/:event/severity/"
⇒6
Browse more samples
7.25.3 Event parameters
array autoping/notifications/events/S/parameters/
Additional data associated with the event
Event parameterid:Identifierhas_fixed_value:Fixed value flagfixed_value:Fixed value
Event parameters[element]:Event parameter
0..*
check Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Event parameter elements.
Creating elements in this collection is not supported.
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/autoping/notifications/events/:event/parameters/"
⇒
DLI V222 Object Model Reference: 20210317T201932Z
494 CONTENTS
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.autoping.notifications.events[_event].parameters))
⇒
Browse more samples
See also Event parameters: Event parameter
8 Scripting server object
object script/
Object representing the scripting server state and configuration
Script snippets[element]:Script snippet
Administrative userAdministratorRegular user
can_read,can_write
User functions[element]:User script function signature
can_read
check
User function UI order[element]:User script function name for index
can_read
Thread map[element]:Scripting thread
can_read
check
Script external variables[element]:Script external variable
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
Scripting server objectsource:User script sourcesnippets:Script snippetsuser_functions:User functionsuser_function_ui_order:User function UI orderboot_handler:Script to start at startup, if anyboot_handler_legacy:Legacy startup handlingthreads:Thread map
start ( Code source ) -> ( Resulting thread ID )
stop ( Thread(s) to stop ) -> ( Empty result )
variables:Script external variablestraced:Script tracingstep_delay:Script step delaystep_time_limit:Script step time limitnotifications:Notifications
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
source User script source
snippets Script snippets
user_functions User functionsuser_function_ui_order User function UI orderboot_handler Script to start at startup, if any
boot_handler_legacy Legacy startup handling
threads Thread map
start Start a script thread
stop Stop a script thread
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 495
variables Script external variables
traced Script tracing
step_delay Script step delay
step_time_limit Script step time limit
notifications Notifications
Sample uom library read command:
print(uom.dump(uom.script))
⇒<...>
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/script/"
Browse more samples
8.1 User script source
string script/source/
Source of the user script from which user functions are extracted
User script source Administrative userAdministratorRegular user
can_read,can_write
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 not administrative user
This string represents a value in persistent storage.
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 "\"function ←↩↪→ cycle_contraptions(...)\\n ...\\nend\\n\"" "http://192.168.0.100/restapi/ ←↩↪→ script/source/"
DLI V222 Object Model Reference: 20210317T201932Z
496 CONTENTS
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/script/source/',auth=auth, ←↩↪→ headers=headers).json())
⇒'function energize_router(...)\n ...\nend\nfunction energize_heater(...)\n ...\ ←↩
↪→ nend\nfunction disable_modem(...)\n ...\nend\nfunction energize_machines ←↩↪→ (...)\n ...\nend\n'
Browse more samples
8.2 Script snippets
map script/snippets/
Fragments of Lua code provided initially as samples or saved for later use
Script snippetsource:Snippet source
Script snippets[element]:Script snippet
0..*
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This map represents a value in persistent storage.
Changes to this map cannot be tracked.
This map contains Script snippet elements.
Sample uom library script snippet creation command:
uom.insert(uom.script.snippets,"enable_appliance_sample",{source="function ←↩↪→ cycle_appliance(...)\
...\end\function enable_modems(...)\...\
end\function enable_machine(...)\...\
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 497
end\function shut_down_routers(...)\...\
end\"})
Sample JS request read command:
request.get({url:"script/snippets/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒
Browse more samples
See also Script snippets: Script snippet
8.3 Script snippets: Script snippet
object script/snippets/S/
User script snippet
This object contains the following items:
source Snippet source
Sample CLI write command (note that script_snippet is a variable):
uom set "script/snippets/${script_snippet}" "{\"source\":\"function ←↩↪→ toggle_engines(...)\\n ...\\nend\\nfunction toggle_gadgets(...)\\n ...\\ ←↩↪→ nend\\nfunction shut_down_engine(...)\\n ...\\nend\\n\"}"
Sample curl deletion command (note that :script_snippet is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X DELETE -H "Accept: application/json ←↩↪→ " "http://192.168.0.100/restapi/script/snippets/:script_snippet/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
498 CONTENTS
8.3.1 Snippet source
string script/snippets/S/source/
Source of the snippet
Snippet source Administrative userAdministratorRegular user
can_read,can_write
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 not administrative user
This string represents a value in persistent storage.
Changes to this string cannot be tracked.
Sample CLI write command (note that script_snippet is a variable):
uom set "script/snippets/${script_snippet}/source" "\"function ←↩↪→ enable_contraptions(...)\\n ...\\nend\\n\""
Sample JS request write command (note that _script_snippet is a variable):
request.put({url:"script/snippets/"+_script_snippet+"/source/",body:"function ←↩↪→ enable_routers(...)\n ...\nend\nfunction disable_machines(...)\n ...\nend\ ←↩↪→ nfunction toggle_modem(...)\n ...\nend\n"});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 499
8.4 User functions
map script/user_functions/
Mapping of user function names to their signatures
User functions[element]:User script function signature
check
Administrative userAdministratorRegular user
can_read
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 User script function signature elements.
Creating elements in this collection is not supported.
Sample CLI read command:
uom get "script/user_functions"
⇒[]
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/script/user_functions/"
⇒[]
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
500 CONTENTS
8.4.1 User script function signature
string script/user_functions/S/
Indicates that the map key is a user script function, and provides a signature which may serve as a hint as to thefunction content
User script function signature Administrative userAdministratorRegular user
can_read
The value is subject to the following constraints: not index of the value matches ∧(|.∗|.∗)$
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 :user_script_function_signature is a URL templateargument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/script/user_functions/:user_script_function_signature/"
⇒[]
Sample CLI read command (note that user_script_function_signature is a variable):
uom get "script/user_functions/${user_script_function_signature}"
⇒[]
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 501
8.5 User function UI order
array script/user_function_ui_order/
Preferred order of user functions when displayed to user
User function UI order[element]:User script function name for index
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array does not support direct modification.
This array can change as if by itself or indirectly because of other actions.
Changes to this array cannot be tracked.
This array contains User script function name for index elements.
Creating elements in this collection is not supported.
Sample CLI read command:
uom get "script/user_function_ui_order"
⇒["disable_engine","enable_gadgets","disable_gadgets","enable_heaters"," ←↩
↪→ cycle_contraption","shut_down_routers"]
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/script/user_function_ui_order/"
⇒["disable_appliances","cycle_gadgets"]
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
502 CONTENTS
8.5.1 User script function name for index
string script/user_function_ui_order/N/
Indicates that the preferred location of this user function in a list is the index in the array; may specify a nonexistentfunction
User script function name for index Administrative userAdministratorRegular user
can_read
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 _user_script_function_name_for_index_index isa variable):
request.get({url:"script/user_function_ui_order/"+ ←↩↪→ _user_script_function_name_for_index_index.toString()+"/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒"disable_modems"
Sample uom library read command (note that _user_script_function_name_for_index_index is avariable):
print(uom.dump(uom.script.user_function_ui_order[ ←↩↪→ _user_script_function_name_for_index_index]))
⇒"enable_appliance"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 503
8.6 Script to start at startup, if any
sum (string) script/boot_handler/
User scripting function to run at startup, if any
Script to start at startup, if anyScript to start at startupNone
Administrative userAdministratorRegular user
can_read,can_write
User functions[element]:User script function signature
check
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
string Script to start at startup User scripting function to run at startup,with the startup reason as argument (oronly at cold boot if configured to)
user functions[the value]
constant "" None Don't run any scripting function at startup
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/script/boot_handler/"
Sample requests write command:
requests.put('http://192.168.0.100/restapi/script/boot_handler/',auth=auth, ←↩↪→ headers=headers,json='')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
504 CONTENTS
8.7 Legacy startup handling
sum (boolean) script/boot_handler_legacy/
Run startup script only on cold boot and omit the argument
Legacy startup handlingEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
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 "false" "http ←↩↪→ ://192.168.0.100/restapi/script/boot_handler_legacy/"
Sample CLI write command:
uom set "script/boot_handler_legacy" "true"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 505
8.8 Thread map
map script/threads/
Map of user scripting threads
Scripting threadlabel:Label
Thread map[element]:Scripting thread
0..*
check Administrative userAdministratorRegular user
can_read
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 Scripting thread elements.
Creating elements in this collection is not supported.
Sample uom library read command:
print(uom.dump(uom.script.threads))
⇒{["82"]={label="label of thread #82"},["90"]={label="label of thread #90"}}
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/script/threads/"
⇒{"8":{"label":"label of thread #8"}}
Browse more samples
See also Thread map: Scripting thread
DLI V222 Object Model Reference: 20210317T201932Z
506 CONTENTS
8.9 Thread map: Scripting thread
object script/threads/S/
User scripting thread status
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
label Label
Sample requests write command (note that _scripting_thread is a variable):
requests.put('http://192.168.0.100/restapi/script/threads/'+_scripting_thread ←↩↪→ +'/',auth=auth,headers=headers,json={'label': 'label of thread #81'})
Sample requests read command (note that _scripting_thread is a variable):
print(requests.get('http://192.168.0.100/restapi/script/threads/'+ ←↩↪→ _scripting_thread+'/',auth=auth,headers=headers).json())
⇒{'label': 'label of thread #1'}
Browse more samples
8.9.1 Label
string script/threads/S/label/
User thread label
Label Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 507
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 _scripting_thread is a variable):
print(requests.get('http://192.168.0.100/restapi/script/threads/'+ ←↩↪→ _scripting_thread+'/label/',auth=auth,headers=headers).json())
⇒'label of thread #59'
Sample CLI read command (note that scripting_thread is a variable):
uom get "script/threads/${scripting_thread}/label"
⇒"label of thread #84"
Browse more samples
8.10 Start a script thread
call script/start/
Start a user scripting thread
Code sourceuser_function:User function, if anysource:User code, if anydisplayed_source:Displayed source code, if anyStart a script thread
argument
Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if not administrative user
The call accepts the following arguments:
1. Code source: object "Code source"
The call returns the following results:
DLI V222 Object Model Reference: 20210317T201932Z
508 CONTENTS
1. Resulting thread ID: string
Sample requests invocation:
print(requests.post('http://192.168.0.100/restapi/script/start/',auth=auth, ←↩↪→ headers=headers,json=[{'displayed_source': 'Enable modems', 'user_function ←↩↪→ ': 'enable_modems'}]).json())
⇒'25'
Sample JS request invocation:
request.post({url:"script/start/",body:[{"source":"fn(\"gadget\")","user_function ←↩↪→ ":"enable_gadgets"}]});
⇒"48"
Browse more samples
See also Start a script thread: Code source
8.10.1 Resulting thread ID
string script/start/results: 1/
Identifier of the started thread
Resulting thread ID Thread map[element]:Scripting thread
check
The value is subject to the following constraints: thread map[the value]
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 509
8.11 Start a script thread: Code source
object script/start/arguments: 1/
Source of the code to run
This object does not correspond to an actual resource.
This object contains the following items:
user_function User function, if any
source User code, if any
displayed_source Displayed source code, if any
8.11.1 User function, if any
sum (optional string) script/start/arguments: 1/user_function/
Name of user function to run, if any
User function, if anyNo user function is runUser function
User functions[element]:User script function signature
check
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null No user function is run The source of code is not a user functionstring User function Name of user function to run user functions[the value]
DLI V222 Object Model Reference: 20210317T201932Z
510 CONTENTS
8.11.2 User code, if any
sum (optional string) script/start/arguments: 1/source/
Explicit code to run as user script (if user_function is not set or is an existing user script function), if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null User function invocation The user_function is invoked with no arguments
string User code Explicit code to run as user script (if user_function isnot set or is an existing user script function)
8.11.3 Displayed source code, if any
sum (optional string) script/start/arguments: 1/displayed_source/
Source code describing thread overview (doesn't have to be valid code), if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Use default Display source, or user_function name
string Displayed source code Source code describing thread overview (doesn't haveto be valid code)
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 511
8.12 Stop a script thread
call script/stop/
Stop a user scripting thread, or all user scripting threads
Stop a script thread Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if not administrative user
The call accepts the following arguments:
1. Thread(s) to stop: Thread ID or All threads
The call returns the following results:
1. Empty result: null
Sample requests invocation:
requests.post('http://192.168.0.100/restapi/script/stop/',auth=auth,headers= ←↩↪→ headers,json=['3'])
⇒(no output)
Sample CLI invocation:
uom invoke "script/stop" "\"all\""
⇒(no output)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
512 CONTENTS
8.12.1 Thread(s) to stop
sum (string) script/stop/arguments: 1/
Identifier of the thread to stop, or "all" to stop all threads
Thread(s) to stopThread IDAll threads
Thread map[element]:Scripting thread
check
This sum does not correspond to an actual resource.
This sum can assume the following values:
string Thread ID Identifier of the thread to stop thread map[the value]
constant "all" All threads Stop all threads
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 513
8.12.2 Empty result
constant null script/stop/results: 1/
No additional information available
This constant does not correspond to an actual resource.
8.13 Script external variables
map script/variables/
Elements of the script's external table
This map can change as if by itself or indirectly because of other actions.
This map contains Script external variable elements.
Sample requests script external variable creation command:
requests.put('http://192.168.0.100/restapi/script/variables/engine_state/',auth= ←↩↪→ auth,headers=headers,json=True)
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 "{\"engine_state\":1,\" ←↩↪→ contraption_status\":\"good\",\"gadget_online\":true,\"heater_status\":3,\" ←↩↪→ router_status\":false,\"machine_state\":\"failed\",\"contraption_running ←↩↪→ \":1,\"heater_temperature\":true,\"gadget_running\":true,\"router_state ←↩↪→ \":5,\"heater_online\":4}" "http://192.168.0.100/restapi/script/variables/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
514 CONTENTS
8.13.1 Script external variable
sum (variant) script/variables/S/
Element of the script's external table
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant true True Trueconstant false False Falsestring String This string
number Number This number
Sample JS request deletion command (note that _script_external_variable is a variable):
request.delete({url:"script/variables/"+_script_external_variable+"/"});
Sample CLI read command (note that script_external_variable is a variable):
uom get "script/variables/${script_external_variable}"
⇒"no"
Browse more samples
8.14 Script tracing
sum (boolean) script/traced/
Perform step-by-step logging of script operation
Script tracingEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 515
This sum represents a value in persistent storage.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
516 CONTENTS
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample uom library write command:
uom.script.traced=false
Sample JS request read command:
request.get({url:"script/traced/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒false
Browse more samples
8.15 Script step delay
number script/step_delay/
Delay after executing legacy scripting functions
Script step delay Administrative userAdministratorRegular user
can_read,can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/script/step_delay/"
⇒
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 517
1
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 "1" "http ←↩↪→ ://192.168.0.100/restapi/script/step_delay/"
Browse more samples
8.16 Script step time limit
number script/step_time_limit/
Maximum amount of time a scripting thread is allowed to run uninterrupted
Script step time limit Administrative userAdministratorRegular user
can_read,can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample uom library write command:
uom.script.step_time_limit=20
Sample JS request write command:
request.put({url:"script/step_time_limit/",body:20});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
518 CONTENTS
8.17 Notifications
object script/notifications/
Scripting server notifications
Parameter kindsscript_message:Script messagescript_data:Script datathread_id:Thread IDthread_name:Thread namethread_origin:Thread origin, if anythread_start_reason:Thread start reason, if anythread_stop_reason:Thread stop reasonthread_state:Thread statethread_error:Thread error
check
Events[element]:Event
Administrative userAdministratorRegular user
can_read
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
Retrieving the value is denied if not administrative user
This object does not support direct modification.
This object contains the following items:
parameter_kinds Parameter kinds
events Events
Sample CLI read command:
uom get "script/notifications"
⇒...
Sample uom library read command:
print(uom.dump(uom.script.notifications))
⇒<...>
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 519
8.17.1 Parameter kinds
object script/notifications/parameter_kinds/
Kinds of event parameters
Script data[element]:Script data element
Parameter kindsscript_message:Script messagescript_data:Script datathread_id:Thread IDthread_name:Thread namethread_origin:Thread origin, if anythread_start_reason:Thread start reason, if anythread_stop_reason:Thread stop reasonthread_state:Thread statethread_error:Thread error
check
This object does not correspond to an actual resource.
This object contains the following items:
script_message Script message
script_data Script data
thread_id Thread IDthread_name Thread namethread_origin Thread origin, if any
thread_start_reason Thread start reason, if any
thread_stop_reason Thread stop reason
thread_state Thread statethread_error Thread error
See also Parameter kinds: Script message
See also Parameter kinds: Script data
See also Parameter kinds: Thread ID
See also Parameter kinds: Thread name
See also Parameter kinds: Thread origin, if any
See also Parameter kinds: Thread start reason, if any
See also Parameter kinds: Thread stop reason
See also Parameter kinds: Thread state
See also Parameter kinds: Thread error
DLI V222 Object Model Reference: 20210317T201932Z
520 CONTENTS
8.17.2 Events
map script/notifications/events/
Event templates
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
Events[element]:Event
0..*
Administrative userAdministratorRegular user
can_read
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 Event elements.
Creating elements in this collection is not supported.
Sample JS request read command:
request.get({url:"script/notifications/events/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒<...>
Sample CLI read command:
uom get "script/notifications/events"
⇒...
Browse more samples
See also Events: Event
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 521
8.18 Parameter kinds: Script message
string script/notifications/parameter_kinds/script_message/
Message for the script-generated event
8.19 Parameter kinds: Script data
map script/notifications/parameter_kinds/script_data/
Data of the script-generated event
This map contains Script data element elements.
8.19.1 Script data element
sum (variant) script/notifications/parameter_kinds/script_data/S/
Element of script-generated event data
This sum can assume the following values:
constant null Null Nullconstant true True Trueconstant false False Falsestring String This string
number Number This number
DLI V222 Object Model Reference: 20210317T201932Z
522 CONTENTS
8.20 Parameter kinds: Thread ID
string script/notifications/parameter_kinds/thread_id/
Thread identifier
8.21 Parameter kinds: Thread name
string script/notifications/parameter_kinds/thread_name/
Thread human-readable name
8.22 Parameter kinds: Thread origin, if any
sum (optional string) script/notifications/parameter_kinds/thread_origin/
Origin of the thread, if any
This sum can assume the following values:
constant null Unknown origin Origin of this thread is not known
string Thread origin Origin of the thread
8.23 Parameter kinds: Thread start reason, if any
sum (optional string) script/notifications/parameter_kinds/thread_start_reason/
Reason of the thread start, if any
This sum can assume the following values:
constant null Unknown start reason Reason of the thread start is not knownstring Thread start reason Reason of the thread start
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 523
8.24 Parameter kinds: Thread stop reason
string script/notifications/parameter_kinds/thread_stop_reason/
Reason of the thread stop
8.25 Parameter kinds: Thread state
sum (boolean) script/notifications/parameter_kinds/thread_state/
Thread execution state
This sum can assume the following values:
constant true Running The thread is running
constant false Stopped The thread is stopped
8.26 Parameter kinds: Thread error
string script/notifications/parameter_kinds/thread_error/
Thread execution error description
8.27 Event parameters: Event parameter
object script/notifications/events/S/parameters/N/
Properties of a parameter associated with the event
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
id Identifierhas_fixed_value Fixed value flag
fixed_value Fixed value
Sample JS request write command (note that _event and _event_parameter_index are variables):
request.put({url:"script/notifications/events/"+_event+"/parameters/"+ ←↩↪→ _event_parameter_index.toString()+"/",body:{"fixed_value":null," ←↩↪→ has_fixed_value":false,"id":"thread_name"}});
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.script.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index]))
⇒{fixed_value=null,has_fixed_value=false,id="thread_id"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
524 CONTENTS
8.27.1 Identifier
string script/notifications/events/S/parameters/N/id/
Parameter identifier
Identifier
Parameter kindsscript_message:Script messagescript_data:Script datathread_id:Thread IDthread_name:Thread namethread_origin:Thread origin, if anythread_start_reason:Thread start reason, if anythread_stop_reason:Thread stop reasonthread_state:Thread statethread_error:Thread error
check
Administrative userAdministratorRegular user
can_read
The value is subject to the following constraints: parameter kinds[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 requests read command (note that _event and _event_parameter_index are variables):
print(requests.get('http://192.168.0.100/restapi/script/notifications/events/'+ ←↩↪→ _event+'/parameters/'+str(_event_parameter_index)+'/id/',auth=auth,headers= ←↩↪→ headers).json())
⇒'thread_origin'
Sample JS request read command (note that _event and _event_parameter_index are variables):
request.get({url:"script/notifications/events/"+_event+"/parameters/"+ ←↩↪→ _event_parameter_index.toString()+"/id/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"thread_error"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 525
8.27.2 Fixed value flag
sum (boolean) script/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
Fixed value flagFixedVariable
Administrative userAdministratorRegular user
can_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 Fixed The value is fixedconstant false Variable The value is variable
Sample requests read command (note that _event and _event_parameter_index are variables):
print(requests.get('http://192.168.0.100/restapi/script/notifications/events/'+ ←↩↪→ _event+'/parameters/'+str(_event_parameter_index)+'/has_fixed_value/',auth= ←↩↪→ auth,headers=headers).json())
⇒False
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.script.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].has_fixed_value))
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
526 CONTENTS
8.27.3 Fixed value
sum (variant) script/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
Fixed valueNullTrueFalseStringNumber
Administrative userAdministratorRegular user
can_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 null Null Nullconstant true True Trueconstant false False Falsestring String This string
number Number This number
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.script.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].fixed_value))
⇒null
Sample requests read command (note that _event and _event_parameter_index are variables):
print(requests.get('http://192.168.0.100/restapi/script/notifications/events/'+ ←↩↪→ _event+'/parameters/'+str(_event_parameter_index)+'/fixed_value/',auth=auth ←↩↪→ ,headers=headers).json())
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 527
⇒None
Browse more samples
8.28 Events: Event
object script/notifications/events/S/
Event template
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
can_readcheck
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
message_template Message template
severity Severity
parameters Event parameters
Sample JS request write command (note that _event is a variable):
request.put({url:"script/notifications/events/"+_event+"/",body:{"severity":6," ←↩↪→ message_template":[0,":",1," [",2,"] (",3,") stopped: ",4],"parameters":[{" ←↩↪→ fixed_value":null,"has_fixed_value":false,"id":"thread_id"},{"fixed_value": ←↩↪→ null,"has_fixed_value":false,"id":"thread_name"},{"fixed_value":null," ←↩↪→ has_fixed_value":false,"id":"thread_origin"},{"fixed_value":null," ←↩↪→ has_fixed_value":false,"id":"thread_start_reason"},{"fixed_value":null," ←↩↪→ has_fixed_value":false,"id":"thread_stop_reason"},{"fixed_value":false," ←↩↪→ has_fixed_value":true,"id":"thread_state"}]}});
Sample uom library write command (note that _event is a variable):
uom.script.notifications.events[_event]={message_template={0,":",1," [",2,"] ←↩↪→ (",3,") stopped: ",4},parameters={{fixed_value=null,has_fixed_value=false, ←↩↪→ id="thread_id"},{fixed_value=null,has_fixed_value=false,id="thread_name"},{ ←↩↪→ fixed_value=null,has_fixed_value=false,id="thread_origin"},{fixed_value= ←↩↪→ null,has_fixed_value=false,id="thread_start_reason"},{fixed_value=null, ←↩↪→ has_fixed_value=false,id="thread_stop_reason"},{fixed_value=false, ←↩↪→ has_fixed_value=true,id="thread_state"}},severity=6}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
528 CONTENTS
8.28.1 Message template
array script/notifications/events/S/message_template/
Template for human-readable message generation
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Message template element elements.
Creating elements in this collection is not supported.
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/script/notifications/events/:event/message_template/"
⇒["no longer running a script function at boot since the function no longer exists ←↩
↪→ in the script source"]
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/script/notifications/events/'+ ←↩↪→ _event+'/message_template/',auth=auth,headers=headers).json())
⇒[0, ':', 1, ' [', 2, '] (', 3, ') failed: ', 4]
Browse more samples
8.28.1.1 Message template element
sum (variant) script/notifications/events/S/message_template/N/
Element of human-readable message template
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 529
Message template elementStringParameter
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
check
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:
string String Fixed string
number Parameter Index of message parameter to insert event parameters[the value]
Sample CLI read command (note that event and message_template_element_index are variables):
uom get "script/notifications/events/${event}/message_template/${ ←↩↪→ message_template_element_index}"
⇒" ["
Sample uom library read command (note that _event and _message_template_element_index arevariables):
print(uom.dump(uom.script.notifications.events[_event].message_template[ ←↩↪→ _message_template_element_index]))
⇒"no longer running a script function at boot since the function no longer exists ←↩
↪→ in the script source"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
530 CONTENTS
8.28.2 Severity
sum (enumerated number) script/notifications/events/S/severity/
Severity rating assigned to the event
SeverityEmergencyAlertCriticalErrorWarningNoticeInformationalDebug
Administrative userAdministratorRegular user
can_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 1 Emergency Treat the event as an emergency
constant 2 Alert Treat the event as an alertconstant 3 Critical Treat the event as criticalconstant 4 Error Treat the event as an errorconstant 5 Warning Treat the event as a warning
constant 6 Notice Treat the event as a noticeconstant 7 Informational Treat the event as informationalconstant 8 Debug Treat the event as debugging-related
Sample CLI read command (note that event is a variable):
uom get "script/notifications/events/${event}/severity"
DLI V222 Object Model Reference: 20210317T201932Z
8 Scripting server object 531
⇒6
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/script/notifications/events/'+ ←↩↪→ _event+'/severity/',auth=auth,headers=headers).json())
⇒5
Browse more samples
8.28.3 Event parameters
array script/notifications/events/S/parameters/
Additional data associated with the event
Event parameterid:Identifierhas_fixed_value:Fixed value flagfixed_value:Fixed value
Event parameters[element]:Event parameter
0..*
check Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Event parameter elements.
Creating elements in this collection is not supported.
Sample CLI read command (note that event is a variable):
uom get "script/notifications/events/${event}/parameters"
⇒
DLI V222 Object Model Reference: 20210317T201932Z
532 CONTENTS
[]
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/script/notifications/events/:event/parameters/"
⇒
Browse more samples
See also Event parameters: Event parameter
9 SNMP server object
object snmp/
Object representing SNMP server configuration
OID subtrees[element]:OID subtree
check
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Users[element]:User can_read,can_write
can_writecheck
Community mappings[element]:Community mapping
can_read,can_write
can_write
Known authentication methods[element]:Authentication method
can_read
check
Known privacy methods[element]:Privacy method
can_read
check
SNMP server objectenabled:Allow SNMPengine_id:Engine IDoid_subtrees:OID subtreesusers:Userscommunity_mappings:Community mappingsknown_auth_methods:Known authentication methodsknown_priv_methods:Known privacy methods
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
enabled Allow SNMPengine_id Engine ID
oid_subtrees OID subtreesusers Userscommunity_mappings Community mappings
known_auth_methods Known authentication methodsknown_priv_methods Known privacy methods
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 533
Sample uom library write command:
uom.snmp={community_mappings={{community="ZQFjq855VWMJ",ip_address ←↩↪→ ="10.192.227.189",netmask="255.0.0.0",user="useraS4o"}},enabled=true, ←↩↪→ engine_id="24DE304F",known_auth_methods={md5="MD5",sha1="SHA1"}, ←↩↪→ known_priv_methods={aes="AES",des="DES"},oid_subtrees={energyObject={ ←↩↪→ read_security_level="noauth",root="1.3.6.1.2.1.229",title="energyObject MIB ←↩↪→ (RFC 7460, allows manipulating relays and power-related meters)", ←↩↪→ write_security_level="noauth"}},users={powerAdmin={auth_method="md5", ←↩↪→ auth_password="adminAuthPassword",has_auth_password=false,has_priv_password ←↩↪→ =false,is_allowed=false,priv_method="aes",priv_password="adminPrivPassword ←↩↪→ ",subtree_access={energyObject=true}},powerReader={auth_method="md5", ←↩↪→ auth_password="readerAuthPassword",has_auth_password=true,has_priv_password ←↩↪→ =false,is_allowed=true,priv_method="aes",priv_password="readerPrivPassword ←↩↪→ ",subtree_access={energyObject="readonly"}}}}
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/snmp/"
⇒
Browse more samples
9.1 Allow SNMP
sum (boolean) snmp/enabled/
Enable SNMP server operation
Allow SNMPEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
DLI V222 Object Model Reference: 20210317T201932Z
534 CONTENTS
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample requests write command:
requests.put('http://192.168.0.100/restapi/snmp/enabled/',auth=auth,headers= ←↩↪→ headers,json=True)
Sample uom library read command:
print(uom.dump(uom.snmp.enabled))
⇒true
Browse more samples
9.2 Engine ID
string snmp/engine_id/
The engine ID, in hexadecimal, to which all user authentication and privacy keys are localized
Engine ID
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: the value matches ∧([0-9A-Fa-f]{2})∗$
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 535
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI write command:
uom set "snmp/engine_id" "\"B63474CCD80C8B0B9102\""
Sample uom library write command:
uom.snmp.engine_id="50D8BF46392A7DF31AB8"
Browse more samples
9.3 OID subtrees
map snmp/oid_subtrees/
OID subtrees exposed by SNMP server
OID subtreetitle:Titleroot:Root maskread_security_level:Read security levelwrite_security_level:Write security level
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
OID subtrees[element]:OID subtree
0..*
can_read,can_write
can_write
check
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This map represents a value in persistent storage.
This map contains OID subtree elements.
Sample requests read command:
DLI V222 Object Model Reference: 20210317T201932Z
536 CONTENTS
print(requests.get('http://192.168.0.100/restapi/snmp/oid_subtrees/',auth=auth, ←↩↪→ headers=headers).json())
⇒{'energyObject': {'read_security_level': 'noauth', 'root': '1.3.6.1.2.1.229', ' ←↩
↪→ title': 'energyObject MIB (RFC 7460, allows manipulating relays and power- ←↩↪→ related meters)', 'write_security_level': 'noauth'}}
Sample JS request read command:
request.get({url:"snmp/oid_subtrees/"},function(error,response,body) {console.log ←↩↪→ (body)});
⇒{"energyObject":{"read_security_level":"noauth","root":"1.3.6.1.2.1.229","title ←↩
↪→ ":"energyObject MIB (RFC 7460, allows manipulating relays and power-related ←↩↪→ meters)","write_security_level":"noauth"}}
Browse more samples
See also OID subtrees: OID subtree
9.4 OID subtrees: OID subtree
object snmp/oid_subtrees/S/
Properties of an OID subtree
OID subtreetitle:Titleroot:Root maskread_security_level:Read security levelwrite_security_level:Write security level
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This object represents a value in persistent storage.
This object contains the following items:
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 537
title Titleroot Root maskread_security_level Read security level
write_security_level Write security level
Sample curl write command (note that :oid_subtree 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 "{\"read_security_level ←↩↪→ \":\"noauth\",\"root\":\"1.3.6.1.2.1.229\",\"title\":\"energyObject MIB ( ←↩↪→ RFC 7460, allows manipulating relays and power-related meters)\",\" ←↩↪→ write_security_level\":\"noauth\"}" "http://192.168.0.100/restapi/snmp/ ←↩↪→ oid_subtrees/:oid_subtree/"
Sample uom library read command (note that _oid_subtree is a variable):
print(uom.dump(uom.snmp.oid_subtrees[_oid_subtree]))
⇒{read_security_level="noauth",root="1.3.6.1.2.1.229",title="energyObject MIB (RFC ←↩
↪→ 7460, allows manipulating relays and power-related meters)", ←↩↪→ write_security_level="noauth"}
Browse more samples
9.4.1 Title
string snmp/oid_subtrees/S/title/
The title of this subtree
Title
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
538 CONTENTS
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample requests write command (note that _oid_subtree is a variable):
requests.put('http://192.168.0.100/restapi/snmp/oid_subtrees/'+_oid_subtree+'/ ←↩↪→ title/',auth=auth,headers=headers,json='energyObject MIB (RFC 7460, allows ←↩↪→ manipulating relays and power-related meters)')
Sample requests read command (note that _oid_subtree is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/oid_subtrees/'+_oid_subtree ←↩↪→ +'/title/',auth=auth,headers=headers).json())
⇒'energyObject MIB (RFC 7460, allows manipulating relays and power-related meters) ←↩
↪→ '
Browse more samples
9.4.2 Root mask
string snmp/oid_subtrees/S/root/
The root OID mask of this subtree (for all but the first two arcs, '∗' can be used for "don't care" parts, and inclusiveranges can be specified like '1,2,4-7')
Root mask
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: the value matches ∧(0|1|(01|2)(.(∗|(0|[1-9][0-9]∗)(-(0|[1-9][0-9]∗))?(,(0|[1-9][0-9]∗)(-(0|[1-9][0-9]∗))?)∗))∗)$
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 539
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI read command (note that oid_subtree is a variable):
uom get "snmp/oid_subtrees/${oid_subtree}/root"
⇒"1.3.6.1.2.1.229"
Sample requests read command (note that _oid_subtree is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/oid_subtrees/'+_oid_subtree ←↩↪→ +'/root/',auth=auth,headers=headers).json())
⇒'1.3.6.1.2.1.229'
Browse more samples
9.4.3 Read security level
sum (enumerated string) snmp/oid_subtrees/S/read_security_level/
Required security level for reading from this subtree
Read security levelForbiddenAuthenticated and encryptedAuthenticatedMinimal
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
DLI V222 Object Model Reference: 20210317T201932Z
540 CONTENTS
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant "deny" Forbidden Nobody can read from this OID subtree
constant "priv" Authenticated and encrypted SNMPv3 authentication and encryption must be usedto read from this OID subtree
constant "auth" Authenticated SNMPv3 authentication must be used to read from thisOID subtree (encryption is optional)
constant "noauth" Minimal Any protocol, including SNMPv1 and SNMPv2c, canbe used to read from this OID subtree (authenticationand encryption are optional)
Sample uom library read command (note that _oid_subtree is a variable):
print(uom.dump(uom.snmp.oid_subtrees[_oid_subtree].read_security_level))
⇒"noauth"
Sample CLI read command (note that oid_subtree is a variable):
uom get "snmp/oid_subtrees/${oid_subtree}/read_security_level"
⇒"noauth"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 541
9.4.4 Write security level
sum (enumerated string) snmp/oid_subtrees/S/write_security_level/
Required security level for writing to this subtree
Write security levelForbiddenAuthenticated and encryptedAuthenticatedMinimal
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant "deny" Forbidden Nobody can write to this OID subtree
constant "priv" Authenticated and encrypted SNMPv3 authentication and encryption must be usedto write to this OID subtree
constant "auth" Authenticated SNMPv3 authentication must be used to write to thisOID subtree (encryption is optional)
constant "noauth" Minimal Any protocol, including SNMPv1 and SNMPv2c, canbe used to write to this OID subtree (authentication andencryption are optional)
Sample uom library write command (note that _oid_subtree is a variable):
uom.snmp.oid_subtrees[_oid_subtree].write_security_level="noauth"
Sample CLI read command (note that oid_subtree is a variable):
uom get "snmp/oid_subtrees/${oid_subtree}/write_security_level"
⇒"noauth"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
542 CONTENTS
9.5 Users
map snmp/users/
SNMP user accounts
Useris_allowed:User allowedauth_method:Authentication methodhas_auth_password:Authentication password configuredauth_password:Authentication passwordpriv_method:Privacy methodhas_priv_password:Privacy password configuredpriv_password:Privacy passwordsubtree_access:Subtree access levels
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Users[element]:User
0..*
can_read,can_write
can_write
check
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This map represents a value in persistent storage.
This map contains User elements.
Sample CLI write command:
uom set "snmp/users" "{\"powerReader\":{\"priv_password\":\"readerPrivPassword ←↩↪→ \",\"has_auth_password\":true,\"subtree_access\":{\"energyObject\":\" ←↩↪→ readonly\"},\"auth_password\":\"readerAuthPassword\",\"is_allowed\":false ←↩↪→ ,\"priv_method\":\"aes\",\"auth_method\":\"sha1\",\"has_priv_password\": ←↩↪→ false},\"powerAdmin\":{\"priv_password\":\"adminPrivPassword\",\" ←↩↪→ has_auth_password\":false,\"subtree_access\":{\"energyObject\":true},\" ←↩↪→ auth_password\":\"adminAuthPassword\",\"is_allowed\":true,\"priv_method ←↩↪→ \":\"des\",\"auth_method\":\"sha1\",\"has_priv_password\":false}}"
Sample uom library read command:
print(uom.dump(uom.snmp.users))
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 543
9.5.1 User
object snmp/users/S/
Properties of an SNMP user
Subtree access levels[element]:Subtree access
Useris_allowed:User allowedauth_method:Authentication methodhas_auth_password:Authentication password configuredauth_password:Authentication passwordpriv_method:Privacy methodhas_priv_password:Privacy password configuredpriv_password:Privacy passwordsubtree_access:Subtree access levels
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: index of the value matches ∧[a-zA-Z0-9]∗$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This object represents a value in persistent storage.
This object contains the following items:
is_allowed User allowedauth_method Authentication methodhas_auth_password Authentication password configured
auth_password Authentication password
priv_method Privacy method
has_priv_password Privacy password configured
priv_password Privacy password
subtree_access Subtree access levels
Sample uom library deletion command (note that _user is a variable):
uom.remove(uom.snmp.users,_user)
Sample requests deletion command (note that _user is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
544 CONTENTS
requests.delete('http://192.168.0.100/restapi/snmp/users/'+_user+'/',auth=auth, ←↩↪→ headers=headers)
Browse more samples
See also User: User allowed
See also User: Authentication method
See also User: Authentication password configured
See also User: Authentication password
See also User: Privacy method
See also User: Privacy password configured
See also User: Privacy password
See also User: Subtree access levels
9.6 User: User allowed
sum (boolean) snmp/users/S/is_allowed/
Flag indicating whether user is allowed or denied
User allowedAllowedDenied
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 545
This sum represents a value in persistent storage.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
546 CONTENTS
constant true Allowed The user is allowed to log in
constant false Denied The user is denied login
Sample requests write command (note that _user is a variable):
requests.put('http://192.168.0.100/restapi/snmp/users/'+_user+'/is_allowed/',auth ←↩↪→ =auth,headers=headers,json=True)
Sample requests read command (note that _user is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/users/'+_user+'/is_allowed ←↩↪→ /',auth=auth,headers=headers).json())
⇒False
Browse more samples
9.7 User: Authentication method
string snmp/users/S/auth_method/
User authentication method
Authentication method
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Known authentication methods[element]:Authentication method
check
The value is subject to the following constraints: known authentication methods[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 547
• protect network settings
This string represents a value in persistent storage.
Sample curl read command (note that :user is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/snmp/users/:user/auth_method/"
⇒"md5"
Sample requests read command (note that _user is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/users/'+_user+'/auth_method ←↩↪→ /',auth=auth,headers=headers).json())
⇒'sha1'
Browse more samples
9.8 User: Authentication password configured
sum (boolean) snmp/users/S/has_auth_password/
Flag indicating if the authentication password has been configured for the user (cleared if engine ID or authenti-cation method changes)
Authentication password configuredConfiguredNot configured
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant true Configured The authentication password has been configured
constant false Not configured The authentication password hasn't been configured,the user won't be able to log inDLI V222 Object Model Reference: 20210317T201932Z
548 CONTENTS
Sample uom library read command (note that _user is a variable):
print(uom.dump(uom.snmp.users[_user].has_auth_password))
⇒false
Sample JS request read command (note that _user is a variable):
request.get({url:"snmp/users/"+_user+"/has_auth_password/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒false
Browse more samples
9.9 User: Authentication password
string snmp/users/S/auth_password/
User authentication password (cannot be read as it is stored localized to the engine ID), empty if not set
Authentication password
Administrative userAdministratorRegular user
can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: any of the following is true:
• the value is equal to ""
• length of the value is greater or equal to 8
Retrieving the value is denied
Changing the value is denied if any of the following is true:
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 549
• not administrative user
• protect network settings
Using the string as a field for indexing into the grandparent collection is denied
This string represents a value in persistent storage.
This string can change as if by itself or indirectly because of other actions.
This string should be displayed in a secure manner.
Representation of the resource cannot be obtained. Attempts to do so via a JSON API will succeed but return'{"$ref":""}' which means "the value of this resource".
Sample requests write command (note that _user is a variable):
requests.put('http://192.168.0.100/restapi/snmp/users/'+_user+'/auth_password/', ←↩↪→ auth=auth,headers=headers,json='readerAuthPassword')
Sample CLI write command (note that user is a variable):
uom set "snmp/users/${user}/auth_password" "\"readerAuthPassword\""
Browse more samples
9.10 User: Privacy method
string snmp/users/S/priv_method/
User privacy method
Privacy method
Administrative userAdministratorRegular user
can_read,can_write
Known privacy methods[element]:Privacy method
check
Protect network settingsProtectedNot protected
can_write
DLI V222 Object Model Reference: 20210317T201932Z
550 CONTENTS
The value is subject to the following constraints: known privacy methods[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI read command (note that user is a variable):
uom get "snmp/users/${user}/priv_method"
⇒"des"
Sample curl read command (note that :user is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/snmp/users/:user/priv_method/"
⇒"des"
Browse more samples
9.11 User: Privacy password configured
sum (boolean) snmp/users/S/has_priv_password/
Flag indicating if the privacy password has been configured for the user (cleared if engine ID or authenticationor privacy method changes)
Privacy password configuredConfiguredNot configured
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 551
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant true Configured The privacy password has been configured
constant false Not configured The privacy password hasn't been configured, the userwon't be able to log in
Sample CLI read command (note that user is a variable):
uom get "snmp/users/${user}/has_priv_password"
⇒false
Sample requests read command (note that _user is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/users/'+_user+'/ ←↩↪→ has_priv_password/',auth=auth,headers=headers).json())
⇒True
Browse more samples
9.12 User: Privacy password
string snmp/users/S/priv_password/
User privacy password (cannot be read as it is stored localized to the engine ID), empty if not set
Privacy password
Administrative userAdministratorRegular user
can_write
Protect network settingsProtectedNot protected
can_write
DLI V222 Object Model Reference: 20210317T201932Z
552 CONTENTS
The value is subject to the following constraints: any of the following is true:
• the value is equal to ""
• length of the value is greater or equal to 8
Retrieving the value is denied
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
Using the string as a field for indexing into the grandparent collection is denied
This string represents a value in persistent storage.
This string can change as if by itself or indirectly because of other actions.
This string should be displayed in a secure manner.
Representation of the resource cannot be obtained. Attempts to do so via a JSON API will succeed but return'{"$ref":""}' which means "the value of this resource".
Sample curl write command (note that :user 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 "\"readerPrivPassword\"" ←↩↪→ "http://192.168.0.100/restapi/snmp/users/:user/priv_password/"
Sample uom library write command (note that _user is a variable):
uom.snmp.users[_user].priv_password="adminPrivPassword"
Browse more samples
9.13 User: Subtree access levels
map snmp/users/S/subtree_access/
OID subtree access levels
This map is composite, i.e. is modified as a whole.
This map represents a value in persistent storage.
This map contains Subtree access elements.
Sample CLI read command (note that user is a variable):
uom get "snmp/users/${user}/subtree_access"
⇒
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 553
{"energyObject":false}
Sample requests subtree access creation command (note that _user is a variable):
requests.put('http://192.168.0.100/restapi/snmp/users/'+_user+'/subtree_access/ ←↩↪→ energyObject/',auth=auth,headers=headers,json='readonly')
Browse more samples
9.13.1 Subtree access
sum (optional variant) snmp/users/S/subtree_access/S/
OID subtree access level
Subtree accessFullRead-onlyNoneDefault
Administrative userAdministratorRegular user
can_read,can_write
OID subtrees[element]:OID subtree
check
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: OID subtrees[index of the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum is a part of a composite value which is modified as a whole.
This sum represents a value in persistent storage.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
554 CONTENTS
constant true Full OIDs can be read and written by the user
constant "readonly" Read-only OIDs can only be read, not written, by the user
constant false None OIDs can neither be read nor written by the user
constant null Default No access rule present (permissions are determinedby parent OID access levels, or denied)
Sample CLI write command (note that user and subtree_access are variables):
uom set "snmp/users/${user}/subtree_access/${subtree_access}" "true"
Sample curl read command (note that :user and :subtree_access are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/snmp/users/:user/subtree_access/:subtree_access/"
⇒"readonly"
Browse more samples
9.14 Community mappings
array snmp/community_mappings/
Mappings of SNMP v1/v2c communities to user names
Community mappingcommunity:Communityuser:Userip_address:IP addressnetmask:Network mask
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Community mappings[element]:Community mapping
0..*
can_read,can_write
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This array represents a value in persistent storage.
This array contains Community mapping elements.
Sample requests community mapping creation command:
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 555
requests.post('http://192.168.0.100/restapi/snmp/community_mappings/',auth=auth, ←↩↪→ headers=headers,json={'ip_address': '192.168.99.124', 'user': 'usertT5tx', ←↩↪→ 'netmask': '255.255.255.0', 'community': 'private'})
Sample uom library read command:
print(uom.dump(uom.snmp.community_mappings))
⇒{{community="HtM7BCTVllj",ip_address="192.168.116.55",netmask="255.255.255.0", ←↩
↪→ user="uservDbRm"}}
Browse more samples
See also Community mappings: Community mapping
9.15 Community mappings: Community mapping
object snmp/community_mappings/N/
Properties of a community mapping
Community mappingcommunity:Communityuser:Userip_address:IP addressnetmask:Network mask
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This object represents a value in persistent storage.
This object contains the following items:
community Community
user Userip_address IP address
netmask Network mask
DLI V222 Object Model Reference: 20210317T201932Z
556 CONTENTS
Sample requests read command (note that _community_mapping_index is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/community_mappings/'+str( ←↩↪→ _community_mapping_index)+'/',auth=auth,headers=headers).json())
⇒{'ip_address': '192.168.68.72', 'user': 'userRw7qx', 'netmask': '255.255.255.0', ←↩
↪→ 'community': 'Xr97cppeK'}
Sample requests write command (note that _community_mapping_index is a variable):
requests.put('http://192.168.0.100/restapi/snmp/community_mappings/'+str( ←↩↪→ _community_mapping_index)+'/',auth=auth,headers=headers,json={'ip_address': ←↩↪→ '192.168.122.63', 'user': 'user7u2W', 'netmask': '255.255.255.0', ' ←↩↪→ community': 'lg33hFyge'})
Browse more samples
9.15.1 Community
string snmp/community_mappings/N/community/
The community identifier
Community
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample curl write command (note that :community_mapping_index is a URL template argument):
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 557
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "\"public\"" "http ←↩↪→ ://192.168.0.100/restapi/snmp/community_mappings/:community_mapping_index/ ←↩↪→ community/"
Sample curl read command (note that :community_mapping_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/snmp/community_mappings/:community_mapping_index/community/"
⇒"public"
Browse more samples
9.15.2 User
string snmp/community_mappings/N/user/
The user identifier
User
Administrative userAdministratorRegular user
can_read,can_write
Users[element]:User
check
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: users[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
DLI V222 Object Model Reference: 20210317T201932Z
558 CONTENTS
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample JS request read command (note that _community_mapping_index is a variable):
request.get({url:"snmp/community_mappings/"+_community_mapping_index.toString() ←↩↪→ +"/user/"},function(error,response,body) {console.log(body)});
⇒"userFrrUc"
Sample uom library write command (note that _community_mapping_index is a variable):
uom.snmp.community_mappings[_community_mapping_index].user="userWSYw4"
Browse more samples
9.15.3 IP address
string snmp/community_mappings/N/ip_address/
IP address allowed to connect
IP address
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 559
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample JS request write command (note that _community_mapping_index is a variable):
request.put({url:"snmp/community_mappings/"+_community_mapping_index.toString() ←↩↪→ +"/ip_address/",body:"10.204.56.151"});
Sample uom library read command (note that _community_mapping_index is a variable):
print(uom.dump(uom.snmp.community_mappings[_community_mapping_index].ip_address))
⇒"10.25.3.174"
Browse more samples
9.15.4 Network mask
string snmp/community_mappings/N/netmask/
Network mask allowed to connect
Network mask
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: the value matches ∧((2(5[42]|4[80]|24)|192|128|0).0.0.0|255.(2(5[42]|4[80]|24)|192|128|0).0.0|255.255.(2(5[42]|4[80]|24)|192|128|0).0|255.255.255.(2(5[542]|4[80]|24)|192|128|0))$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
560 CONTENTS
• protect network settings
This string represents a value in persistent storage.
Sample JS request read command (note that _community_mapping_index is a variable):
request.get({url:"snmp/community_mappings/"+_community_mapping_index.toString() ←↩↪→ +"/netmask/"},function(error,response,body) {console.log(body)});
⇒"255.255.255.0"
Sample curl read command (note that :community_mapping_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/snmp/community_mappings/:community_mapping_index/netmask/"
⇒"255.255.255.0"
Browse more samples
9.16 Known authentication methods
map snmp/known_auth_methods/
Map of known authentication methods
Known authentication methods[element]:Authentication method
check
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map represents a value in persistent storage.
This map contains Authentication method elements.
Creating elements in this collection is not supported.
Sample curl read command:
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 561
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/snmp/known_auth_methods/"
⇒{"sha1":"SHA1","md5":"MD5"}
Sample JS request read command:
request.get({url:"snmp/known_auth_methods/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒{"sha1":"SHA1","md5":"MD5"}
Browse more samples
9.16.1 Authentication method
string snmp/known_auth_methods/S/
Authentication method name
Authentication method Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample uom library read command (note that _authentication_method is a variable):
print(uom.dump(uom.snmp.known_auth_methods[_authentication_method]))
⇒"MD5"
Sample curl read command (note that :authentication_method is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/snmp/known_auth_methods/:authentication_method/"
⇒"SHA1"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
562 CONTENTS
9.17 Known privacy methods
map snmp/known_priv_methods/
Map of known privacy methods
Known privacy methods[element]:Privacy method
check
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map represents a value in persistent storage.
This map contains Privacy method elements.
Creating elements in this collection is not supported.
Sample uom library read command:
print(uom.dump(uom.snmp.known_priv_methods))
⇒{aes="AES",des="DES"}
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/snmp/known_priv_methods/',auth= ←↩↪→ auth,headers=headers).json())
⇒{'aes': 'AES', 'des': 'DES'}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
9 SNMP server object 563
9.17.1 Privacy method
string snmp/known_priv_methods/S/
Privacy method name
Privacy method Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample requests read command (note that _privacy_method is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/known_priv_methods/'+ ←↩↪→ _privacy_method+'/',auth=auth,headers=headers).json())
⇒'AES'
Sample uom library read command (note that _privacy_method is a variable):
print(uom.dump(uom.snmp.known_priv_methods[_privacy_method]))
⇒"AES"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
564 CONTENTS
10 UPnP server object
object upnp/
Object representing the UPnP server configuration
Outlet UPnP configuration settings[element]:Outlet UPnP configuration
Administrative userAdministratorRegular user
can_read,can_write
Outlets[element]:Outlet
check
Protect network settingsProtectedNot protected
can_write
UPnP device profiles[element]:UPnP device profile can_read,can_write
can_writecheck
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
UPnP server objectenabled:Enabledoutlets:Outlet UPnP configuration settingsprofiles:UPnP device profilesnotifications:Notifications
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
enabled Enabledoutlets Outlet UPnP configuration settings
profiles UPnP device profiles
notifications Notifications
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/"
⇒...
Sample CLI read command:
uom get upnp
⇒...
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 565
10.1 Enabled
sum (boolean) upnp/enabled/
UPnP enable status
EnabledEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample CLI write command:
uom set "upnp/enabled" "false"
Sample requests write command:
requests.put('http://192.168.0.100/restapi/upnp/enabled/',auth=auth,headers= ←↩↪→ headers,json=True)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
566 CONTENTS
10.2 Outlet UPnP configuration settings
array upnp/outlets/
Properties related to exposing outlets via UPnP
Outlet UPnP configurationid:Identifierprofile:Profileexposed:Exposedalternate_name:Alternate name, if any
Outlets[element]:Outletcheck
Outlet UPnP configuration settings[element]:Outlet UPnP configuration
0..*
check
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: length of the value is equal to length of outlets
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This array represents a value in persistent storage.
This array contains Outlet UPnP configuration elements.
Sample uom library write command:
uom.upnp.outlets={{alternate_name=null,exposed=true,id="1944d90d0",profile=" ←↩↪→ belkin_wemo_socket"},{alternate_name=null,exposed=true,id="1944d90d1", ←↩↪→ profile="belkin_wemo_socket"},{alternate_name=null,exposed=true,id="1944 ←↩↪→ d90d2",profile="belkin_wemo_socket"},{alternate_name=null,exposed=true,id ←↩↪→ ="1944d90d3",profile="belkin_wemo_socket"},{alternate_name=null,exposed= ←↩↪→ true,id="1944d90d4",profile="belkin_wemo_socket"},{alternate_name=null, ←↩↪→ exposed=true,id="1944d90d5",profile="belkin_wemo_socket"},{alternate_name= ←↩↪→ null,exposed=false,id="1944d90d6",profile="belkin_wemo_socket"},{ ←↩↪→ alternate_name=null,exposed=true,id="1944d90d7",profile="belkin_wemo_socket ←↩↪→ "}}
Sample requests outlet UPnP configuration creation command:
requests.post('http://192.168.0.100/restapi/upnp/outlets/',auth=auth,headers= ←↩↪→ headers,json={'exposed': False, 'alternate_name': None, 'id': '1944d90d6', ←↩↪→ 'profile': 'belkin_wemo_socket'})
Browse more samples
See also Outlet UPnP configuration settings: Outlet UPnP configuration
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 567
10.3 Outlet UPnP configuration settings: Outlet UPnP configuration
object upnp/outlets/N/
Properties related to exposing the outlet via UPnP
Outlet UPnP configurationid:Identifierprofile:Profileexposed:Exposedalternate_name:Alternate name, if any
Outlets[element]:Outlet
check
The value is subject to the following constraints: outlets[index of the value]
This object contains the following items:
id Identifierprofile Profile
exposed Exposed
alternate_name Alternate name, if any
Sample uom library write command (note that _outlet_upnp_configuration_index is a variable):
uom.upnp.outlets[_outlet_upnp_configuration_index]={alternate_name=null,exposed= ←↩↪→ false,id="1944d90d5",profile="belkin_wemo_socket"}
Sample JS request write command (note that _outlet_upnp_configuration_index is a variable):
request.put({url:"upnp/outlets/"+_outlet_upnp_configuration_index.toString()+"/", ←↩↪→ body:{"exposed":false,"alternate_name":null,"id":"1944d90d0","profile":" ←↩↪→ belkin_wemo_socket"}});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
568 CONTENTS
10.3.1 Identifier
string upnp/outlets/N/id/
Outlet device identifier seed
Identifier
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample uom library read command (note that _outlet_upnp_configuration_index is a variable):
print(uom.dump(uom.upnp.outlets[_outlet_upnp_configuration_index].id))
⇒"1944d90d0"
Sample JS request write command (note that _outlet_upnp_configuration_index is a variable):
request.put({url:"upnp/outlets/"+_outlet_upnp_configuration_index.toString()+"/id ←↩↪→ /",body:"1944d90d2"});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 569
10.3.2 Profile
string upnp/outlets/N/profile/
Outlet device profile
Profile
Administrative userAdministratorRegular user
can_read,can_write
UPnP device profiles[element]:UPnP device profile
check
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: UPnP device profiles[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample requests write command (note that _outlet_upnp_configuration_index is a variable):
requests.put('http://192.168.0.100/restapi/upnp/outlets/'+str( ←↩↪→ _outlet_upnp_configuration_index)+'/profile/',auth=auth,headers=headers, ←↩↪→ json='belkin_wemo_socket')
Sample curl read command (note that :outlet_upnp_configuration_index is a URL templateargument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/outlets/:outlet_upnp_configuration_index/profile/"
⇒"belkin_wemo_socket"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
570 CONTENTS
10.3.3 Exposed
sum (boolean) upnp/outlets/N/exposed/
Outlet is exposed via UPnP
ExposedEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample uom library read command (note that _outlet_upnp_configuration_index is a variable):
print(uom.dump(uom.upnp.outlets[_outlet_upnp_configuration_index].exposed))
⇒
true
Sample JS request read command (note that _outlet_upnp_configuration_index is a variable):
request.get({url:"upnp/outlets/"+_outlet_upnp_configuration_index.toString()+"/ ←↩↪→ exposed/"},function(error,response,body) {console.log(body)});
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 571
⇒false
Browse more samples
10.3.4 Alternate name, if any
sum (optional string) upnp/outlets/N/alternate_name/
Alternate name for the same outlet to be used instead of the configured name, if any
Alternate name, if anyConfigured outlet nameAlternate name
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Configured outlet name Use the outlet's configured name
string Alternate name Alternate name for the same outlet to beused instead of the configured name
the value is not equal to ""
Sample requests write command (note that _outlet_upnp_configuration_index is a variable):
requests.put('http://192.168.0.100/restapi/upnp/outlets/'+str( ←↩↪→ _outlet_upnp_configuration_index)+'/alternate_name/',auth=auth,headers= ←↩↪→ headers,json=None)
Sample uom library read command (note that _outlet_upnp_configuration_index is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
572 CONTENTS
print(uom.dump(uom.upnp.outlets[_outlet_upnp_configuration_index].alternate_name) ←↩↪→ )
⇒null
Browse more samples
10.4 UPnP device profiles
map upnp/profiles/
Map of UPnP device exposure settings
UPnP device profilenid:Namespace identifierdevice_xmlns:Device namespacemanufacturer:Manufacturermodel:Modelmodel_number:Model numberuuid_prefix:UUID prefixdevice_type:Device typedevice_version:Device versionservice_xmlns:Service namespaceservice_id:Service IDservice_type:Service typeservice_version:Service versionservice_control_url:Service control URLservice_event_sub_url:Service event subscription URLservice_scpd_url:Service SCPD URLtypes:Variable typesstate_variables:State variablesactions:Action mapsoap_xmlns_prefix_override:SOAP XML namespace prefix override, if anyservice_xmlns_prefix_override:Service XML namespace prefix override, if anyevent_xmlns_prefix_override:Event XML namespace prefix override, if any
UPnP device profiles[element]:UPnP device profile
0..*
check
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protectedcan_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 573
This map represents a value in persistent storage.
This map contains UPnP device profile elements.
Sample uom library UPnP device profile creation command:
uom.insert(uom.upnp.profiles,"belkin_wemo_socket",<...>)
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/upnp/profiles/',auth=auth, ←↩↪→ headers=headers).json())
⇒<...>
Browse more samples
10.4.1 UPnP device profile
object upnp/profiles/S/
UPnP device exposure settings
Variable types[element]:Variable type
check
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
State variables[element]:State variable binding
can_read,can_write
can_writecheck
Action map[element]:Action
can_read,can_write
can_write
UPnP device profilenid:Namespace identifierdevice_xmlns:Device namespacemanufacturer:Manufacturermodel:Modelmodel_number:Model numberuuid_prefix:UUID prefixdevice_type:Device typedevice_version:Device versionservice_xmlns:Service namespaceservice_id:Service IDservice_type:Service typeservice_version:Service versionservice_control_url:Service control URLservice_event_sub_url:Service event subscription URLservice_scpd_url:Service SCPD URLtypes:Variable typesstate_variables:State variablesactions:Action mapsoap_xmlns_prefix_override:SOAP XML namespace prefix override, if anyservice_xmlns_prefix_override:Service XML namespace prefix override, if anyevent_xmlns_prefix_override:Event XML namespace prefix override, if any
This object contains the following items:
nid Namespace identifier
device_xmlns Device namespace
manufacturer Manufacturermodel Modelmodel_number Model numberuuid_prefix UUID prefix
device_type Device type
DLI V222 Object Model Reference: 20210317T201932Z
574 CONTENTS
device_version Device versionservice_xmlns Service namespace
service_id Service IDservice_type Service type
service_version Service versionservice_control_url Service control URLservice_event_sub_url Service event subscription URL
service_scpd_url Service SCPD URL
types Variable types
state_variables State variablesactions Action map
soap_xmlns_prefix_override SOAP XML namespace prefix override, if any
service_xmlns_prefix_override Service XML namespace prefix override, if any
event_xmlns_prefix_override Event XML namespace prefix override, if any
Sample JS request read command (note that _upnp_device_profile is a variable):
request.get({url:"upnp/profiles/"+_upnp_device_profile+"/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒<...>
Sample requests read command (note that _upnp_device_profile is a variable):
print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+ ←↩↪→ _upnp_device_profile+'/',auth=auth,headers=headers).json())
⇒<...>
Browse more samples
See also UPnP device profile: Namespace identifier
See also UPnP device profile: Device namespace
See also UPnP device profile: Manufacturer
See also UPnP device profile: Model
See also UPnP device profile: Model number
See also UPnP device profile: UUID prefix
See also UPnP device profile: Device type
See also UPnP device profile: Device version
See also UPnP device profile: Service namespace
See also UPnP device profile: Service ID
See also UPnP device profile: Service type
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 575
See also UPnP device profile: Service version
See also UPnP device profile: Service control URL
See also UPnP device profile: Service event subscription URL
See also UPnP device profile: Service SCPD URL
See also UPnP device profile: Variable types
See also UPnP device profile: State variables
See also UPnP device profile: Action map
See also UPnP device profile: SOAP XML namespace prefix override, if any
See also UPnP device profile: Service XML namespace prefix override, if any
See also UPnP device profile: Event XML namespace prefix override, if any
10.5 UPnP device profile: Namespace identifier
string upnp/profiles/S/nid/
URN namespace identifier
Namespace identifier
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI write command (note that upnp_device_profile is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
576 CONTENTS
uom set "upnp/profiles/${upnp_device_profile}/nid" "\"Belkin\""
Sample uom library write command (note that _upnp_device_profile is a variable):
uom.upnp.profiles[_upnp_device_profile].nid="Belkin"
Browse more samples
10.6 UPnP device profile: Device namespace
string upnp/profiles/S/device_xmlns/
Device description XML namespace
Device namespace
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI read command (note that upnp_device_profile is a variable):
uom get "upnp/profiles/${upnp_device_profile}/device_xmlns"
⇒"urn:Belkin:device-1-0"
Sample uom library read command (note that _upnp_device_profile is a variable):
print(uom.dump(uom.upnp.profiles[_upnp_device_profile].device_xmlns))
⇒"urn:Belkin:device-1-0"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 577
10.7 UPnP device profile: Manufacturer
string upnp/profiles/S/manufacturer/
Manufacturer name
Manufacturer
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample curl write command (note that :upnp_device_profile 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 "\"Belkin International ←↩↪→ Inc.\"" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/ ←↩↪→ manufacturer/"
Sample CLI read command (note that upnp_device_profile is a variable):
uom get "upnp/profiles/${upnp_device_profile}/manufacturer"
⇒"Belkin International Inc."
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
578 CONTENTS
10.8 UPnP device profile: Model
string upnp/profiles/S/model/
Model name
Model
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample JS request write command (note that _upnp_device_profile is a variable):
request.put({url:"upnp/profiles/"+_upnp_device_profile+"/model/",body:"DLI ←↩↪→ emulated Belkin socket"});
Sample CLI read command (note that upnp_device_profile is a variable):
uom get "upnp/profiles/${upnp_device_profile}/model"
⇒"DLI emulated Belkin socket"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 579
10.9 UPnP device profile: Model number
string upnp/profiles/S/model_number/
Model number string
Model number
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample JS request write command (note that _upnp_device_profile is a variable):
request.put({url:"upnp/profiles/"+_upnp_device_profile+"/model_number/",body:""}) ←↩↪→ ;
Sample requests write command (note that _upnp_device_profile is a variable):
requests.put('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile ←↩↪→ +'/model_number/',auth=auth,headers=headers,json='')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
580 CONTENTS
10.10 UPnP device profile: UUID prefix
string upnp/profiles/S/uuid_prefix/
Outlet device identifier prefix
UUID prefix
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample uom library read command (note that _upnp_device_profile is a variable):
print(uom.dump(uom.upnp.profiles[_upnp_device_profile].uuid_prefix))
⇒"Socket-1_0"
Sample curl write command (note that :upnp_device_profile 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 "\"Socket-1_0\"" "http ←↩↪→ ://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/uuid_prefix/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 581
10.11 UPnP device profile: Device type
string upnp/profiles/S/device_type/
Device type identifier
Device type
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI read command (note that upnp_device_profile is a variable):
uom get "upnp/profiles/${upnp_device_profile}/device_type"
⇒"controllee"
Sample JS request write command (note that _upnp_device_profile is a variable):
request.put({url:"upnp/profiles/"+_upnp_device_profile+"/device_type/",body:" ←↩↪→ controllee"});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
582 CONTENTS
10.12 UPnP device profile: Device version
string upnp/profiles/S/device_version/
Device version string
Device version
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample JS request write command (note that _upnp_device_profile is a variable):
request.put({url:"upnp/profiles/"+_upnp_device_profile+"/device_version/",body ←↩↪→ :"1"});
Sample uom library write command (note that _upnp_device_profile is a variable):
uom.upnp.profiles[_upnp_device_profile].device_version="1"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 583
10.13 UPnP device profile: Service namespace
string upnp/profiles/S/service_xmlns/
Service description XML namespace
Service namespace
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample uom library read command (note that _upnp_device_profile is a variable):
print(uom.dump(uom.upnp.profiles[_upnp_device_profile].service_xmlns))
⇒"urn:Belkin:service-1-0"
Sample curl read command (note that :upnp_device_profile is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/profiles/:upnp_device_profile/service_xmlns/"
⇒"urn:Belkin:service-1-0"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
584 CONTENTS
10.14 UPnP device profile: Service ID
string upnp/profiles/S/service_id/
Service identifier
Service ID
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample uom library write command (note that _upnp_device_profile is a variable):
uom.upnp.profiles[_upnp_device_profile].service_id="basicevent1"
Sample CLI read command (note that upnp_device_profile is a variable):
uom get "upnp/profiles/${upnp_device_profile}/service_id"
⇒"basicevent1"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 585
10.15 UPnP device profile: Service type
string upnp/profiles/S/service_type/
Service type identifier
Service type
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI read command (note that upnp_device_profile is a variable):
uom get "upnp/profiles/${upnp_device_profile}/service_type"
⇒"basicevent"
Sample requests write command (note that _upnp_device_profile is a variable):
requests.put('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile ←↩↪→ +'/service_type/',auth=auth,headers=headers,json='basicevent')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
586 CONTENTS
10.16 UPnP device profile: Service version
string upnp/profiles/S/service_version/
Service version string
Service version
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI write command (note that upnp_device_profile is a variable):
uom set "upnp/profiles/${upnp_device_profile}/service_version" "\"1\""
Sample requests read command (note that _upnp_device_profile is a variable):
print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+ ←↩↪→ _upnp_device_profile+'/service_version/',auth=auth,headers=headers).json())
⇒'1'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 587
10.17 UPnP device profile: Service control URL
string upnp/profiles/S/service_control_url/
URL to send service control requests to
Service control URL
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample curl read command (note that :upnp_device_profile is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/profiles/:upnp_device_profile/service_control_url/"
⇒"/upnp/control/basicevent1"
Sample CLI write command (note that upnp_device_profile is a variable):
uom set "upnp/profiles/${upnp_device_profile}/service_control_url" "\"/upnp/ ←↩↪→ control/basicevent1\""
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
588 CONTENTS
10.18 UPnP device profile: Service event subscription URL
string upnp/profiles/S/service_event_sub_url/
URL to send service subscription management requests to
Service event subscription URL
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample curl read command (note that :upnp_device_profile is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/profiles/:upnp_device_profile/service_event_sub_url/"
⇒"/upnp/event/basicevent1"
Sample curl write command (note that :upnp_device_profile 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 "\"/upnp/event/ ←↩↪→ basicevent1\"" "http://192.168.0.100/restapi/upnp/profiles/: ←↩↪→ upnp_device_profile/service_event_sub_url/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 589
10.19 UPnP device profile: Service SCPD URL
string upnp/profiles/S/service_scpd_url/
Service control protocol document URL
Service SCPD URL
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample curl read command (note that :upnp_device_profile is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/profiles/:upnp_device_profile/service_scpd_url/"
⇒"/eventservice.xml"
Sample uom library read command (note that _upnp_device_profile is a variable):
print(uom.dump(uom.upnp.profiles[_upnp_device_profile].service_scpd_url))
⇒"/eventservice.xml"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
590 CONTENTS
10.20 UPnP device profile: Variable types
map upnp/profiles/S/types/
Map of supported variable types
Variable typedecode:Decoding functionencode:Encoding function
Variable types[element]:Variable type
0..*
check
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This map is composite, i.e. is modified as a whole.
This map represents a value in persistent storage.
This map contains Variable type elements.
Sample uom library variable type creation command (note that _upnp_device_profile is a variable):
local composite=uom.copy(uom.upnp.profiles[_upnp_device_profile].types)uom.insert(composite,"string",{decode="function(str) return str end",encode=" ←↩
↪→ function(value) return value end"})uom.upnp.profiles[_upnp_device_profile].types=composite
Sample JS request variable type creation command (note that _upnp_device_profile is a variable):
request.put({url:"upnp/profiles/"+_upnp_device_profile+"/types/string/",body:{" ←↩↪→ decode":"function(str) return str end","encode":"function(value) return ←↩↪→ value end"}});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 591
10.20.1 Variable type
object upnp/profiles/S/types/S/
Variable type properties
The value is subject to the following constraints: index of the value matches ∧[a-zA-Z_][a-zA-Z_0-9]∗$
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
decode Decoding function
encode Encoding function
Sample uom library write command (note that _upnp_device_profile and _variable_type arevariables):
uom.upnp.profiles[_upnp_device_profile].types[_variable_type]={decode="function( ←↩↪→ str) return str==\"1\" end",encode="function(value) return value and \"1\" ←↩↪→ or \"0\" end"}
Sample JS request read command (note that _upnp_device_profile and _variable_type arevariables):
request.get({url:"upnp/profiles/"+_upnp_device_profile+"/types/"+_variable_type ←↩↪→ +"/"},function(error,response,body) {console.log(body)});
⇒{"decode":"function(str) return str end","encode":"function(value) return value ←↩
↪→ end"}
Browse more samples
10.20.1.1 Decoding function
string upnp/profiles/S/types/S/decode/
Code of Lua function to decode and validate the value's string representation
DLI V222 Object Model Reference: 20210317T201932Z
592 CONTENTS
Decoding function
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample CLI write command (note that upnp_device_profile and variable_type are variables):
uom set "upnp/profiles/${upnp_device_profile}/types/${variable_type}/decode" "\" ←↩↪→ function(str) return str end\""
Sample JS request write command (note that _upnp_device_profile and _variable_type arevariables):
request.put({url:"upnp/profiles/"+_upnp_device_profile+"/types/"+_variable_type ←↩↪→ +"/decode/",body:"function(str) return str end"});
Browse more samples
10.20.1.2 Encoding function
string upnp/profiles/S/types/S/encode/
Code of Lua function to check and encode the value to string representation
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 593
Encoding function
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample CLI read command (note that upnp_device_profile and variable_type are variables):
uom get "upnp/profiles/${upnp_device_profile}/types/${variable_type}/encode"
⇒"function(value) return value end"
Sample CLI write command (note that upnp_device_profile and variable_type are variables):
uom set "upnp/profiles/${upnp_device_profile}/types/${variable_type}/encode" "\" ←↩↪→ function(value) return value end\""
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
594 CONTENTS
10.21 UPnP device profile: State variables
map upnp/profiles/S/state_variables/
Map of state variable bindings
State variable bindingname:Outlet property nametype:Variable typedefault_value:Default variable nameevents_enabled:Events
State variables[element]:State variable binding
0..*
check
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This map is composite, i.e. is modified as a whole.
This map represents a value in persistent storage.
This map contains State variable binding elements.
Sample JS request write command (note that _upnp_device_profile is a variable):
request.put({url:"upnp/profiles/"+_upnp_device_profile+"/state_variables/",body ←↩↪→ :{"FriendlyName":{"default_value":"","events_enabled":true,"name":"name"," ←↩↪→ type":"string"},"BinaryState":{"default_value":"0","events_enabled":true," ←↩↪→ name":"state","type":"Boolean"}}});
Sample requests read command (note that _upnp_device_profile is a variable):
print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+ ←↩↪→ _upnp_device_profile+'/state_variables/',auth=auth,headers=headers).json())
⇒{'FriendlyName': {'default_value': '', 'events_enabled': True, 'name': 'name', ' ←↩
↪→ type': 'string'}, 'BinaryState': {'default_value': '0', 'events_enabled': ←↩↪→ True, 'name': 'state', 'type': 'Boolean'}}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 595
10.21.1 State variable binding
object upnp/profiles/S/state_variables/S/
Properties of a state variable binding
The value is subject to the following constraints: index of the value matches ∧[a-zA-Z_][a-zA-Z_0-9]∗$
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
name Outlet property name
type Variable type
default_value Default variable nameevents_enabled Events
Sample CLI read command (note that upnp_device_profile and state_variable_binding arevariables):
uom get "upnp/profiles/${upnp_device_profile}/state_variables/${ ←↩↪→ state_variable_binding}"
⇒{"default_value":"0","events_enabled":true,"name":"state","type":"Boolean"}
Sample CLI write command (note that upnp_device_profile and state_variable_binding arevariables):
uom set "upnp/profiles/${upnp_device_profile}/state_variables/${ ←↩↪→ state_variable_binding}" "{\"default_value\":\"\",\"events_enabled\":true ←↩↪→ ,\"name\":\"name\",\"type\":\"string\"}"
Browse more samples
10.21.1.1 Outlet property name
string upnp/profiles/S/state_variables/S/name/
The outlet property to which the variable is bound
DLI V222 Object Model Reference: 20210317T201932Z
596 CONTENTS
Outlet property name
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample CLI read command (note that upnp_device_profile and state_variable_binding arevariables):
uom get "upnp/profiles/${upnp_device_profile}/state_variables/${ ←↩↪→ state_variable_binding}/name"
⇒"state"
Sample requests read command (note that _upnp_device_profile and _state_variable_←↩
binding are variables):
print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+ ←↩↪→ _upnp_device_profile+'/state_variables/'+_state_variable_binding+'/name/', ←↩↪→ auth=auth,headers=headers).json())
⇒'state'
Browse more samples
10.21.1.2 Variable type
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 597
string upnp/profiles/S/state_variables/S/type/
The type of the variable
Variable type
Administrative userAdministratorRegular user
can_read,can_write
Variable types[element]:Variable type
check
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: variable types[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample CLI write command (note that upnp_device_profile and state_variable_binding arevariables):
uom set "upnp/profiles/${upnp_device_profile}/state_variables/${ ←↩↪→ state_variable_binding}/type" "\"Boolean\""
Sample curl read command (note that :upnp_device_profile and :state_variable_binding areURL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/profiles/:upnp_device_profile/state_variables/: ←↩↪→ state_variable_binding/type/"
⇒"Boolean"
Browse more samples
10.21.1.3 Default variable name
DLI V222 Object Model Reference: 20210317T201932Z
598 CONTENTS
string upnp/profiles/S/state_variables/S/default_value/
The string-encoded default value of the state variable
Default variable name
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample requests write command (note that _upnp_device_profile and _state_variable_←↩
binding are variables):
requests.put('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile ←↩↪→ +'/state_variables/'+_state_variable_binding+'/default_value/',auth=auth, ←↩↪→ headers=headers,json='0')
Sample requests read command (note that _upnp_device_profile and _state_variable_←↩
binding are variables):
print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+ ←↩↪→ _upnp_device_profile+'/state_variables/'+_state_variable_binding+'/ ←↩↪→ default_value/',auth=auth,headers=headers).json())
⇒'0'
Browse more samples
10.21.1.4 Events
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 599
sum (boolean) upnp/profiles/S/state_variables/S/events_enabled/
Send events on property change
EventsEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum is a part of a composite value which is modified as a whole.
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample CLI read command (note that upnp_device_profile and state_variable_binding arevariables):
uom get "upnp/profiles/${upnp_device_profile}/state_variables/${ ←↩↪→ state_variable_binding}/events_enabled"
⇒true
Sample curl read command (note that :upnp_device_profile and :state_variable_binding areURL template arguments):
DLI V222 Object Model Reference: 20210317T201932Z
600 CONTENTS
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/profiles/:upnp_device_profile/state_variables/: ←↩↪→ state_variable_binding/events_enabled/"
⇒true
Browse more samples
10.22 Arguments: Argument
object upnp/profiles/S/actions/S/arguments/N/
Action input or output argument properties
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
name Argument name
type Argument type
is_output Output/return value flag
state_id Related state variable identifier, if any
Sample requests read command (note that _upnp_device_profile, _action and _argument_←↩
index are variables):
print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+ ←↩↪→ _upnp_device_profile+'/actions/'+_action+'/arguments/'+str(_argument_index) ←↩↪→ +'/',auth=auth,headers=headers).json())
⇒{'is_output': True, 'state_id': 'FriendlyName', 'name': 'FriendlyName', 'type': ' ←↩
↪→ string'}
Sample CLI deletion command (note that upnp_device_profile, action and argument_index arevariables):
uom remove "upnp/profiles/${upnp_device_profile}/actions/${action}/arguments/${ ←↩↪→ argument_index}"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 601
10.22.1 Argument name
string upnp/profiles/S/actions/S/arguments/N/name/
The name of the argument as seen by clients
Argument name
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: the value matches ∧[a-zA-Z_][a-zA-Z_0-9]∗$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample JS request read command (note that _upnp_device_profile, _action and _argument_←↩
index are variables):
request.get({url:"upnp/profiles/"+_upnp_device_profile+"/actions/"+_action+"/ ←↩↪→ arguments/"+_argument_index.toString()+"/name/"},function(error,response, ←↩↪→ body) {console.log(body)});
⇒"FriendlyName"
Sample requests read command (note that _upnp_device_profile, _action and _argument_←↩
index are variables):
print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+ ←↩↪→ _upnp_device_profile+'/actions/'+_action+'/arguments/'+str(_argument_index) ←↩↪→ +'/name/',auth=auth,headers=headers).json())
⇒'FriendlyName'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
602 CONTENTS
10.22.2 Argument type
string upnp/profiles/S/actions/S/arguments/N/type/
The type of the argument
Argument type
Administrative userAdministratorRegular user
can_read,can_write
Variable types[element]:Variable type
check
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: variable types[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample CLI write command (note that upnp_device_profile, action and argument_index arevariables):
uom set "upnp/profiles/${upnp_device_profile}/actions/${action}/arguments/${ ←↩↪→ argument_index}/type" "\"Boolean\""
Sample curl read command (note that :upnp_device_profile, :action and :argument_index areURL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/profiles/:upnp_device_profile/actions/:action/arguments/: ←↩↪→ argument_index/type/"
⇒"string"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 603
10.22.3 Output/return value flag
sum (boolean) upnp/profiles/S/actions/S/arguments/N/is_output/
Flag indicating that the argument is output/return instead of input
Output/return value flagOutput/returnInput
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum is a part of a composite value which is modified as a whole.
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Output/return The argument is output, and also the return value if it'sthe first output argument
constant false Input The argument is input
Sample requests write command (note that _upnp_device_profile, _action and _argument_←↩
index are variables):
requests.put('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile ←↩↪→ +'/actions/'+_action+'/arguments/'+str(_argument_index)+'/is_output/',auth= ←↩↪→ auth,headers=headers,json=False)
Sample JS request write command (note that _upnp_device_profile, _action and _argument_←↩
index are variables):
request.put({url:"upnp/profiles/"+_upnp_device_profile+"/actions/"+_action+"/ ←↩↪→ arguments/"+_argument_index.toString()+"/is_output/",body:false});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
604 CONTENTS
10.22.4 Related state variable identifier, if any
sum (optional string) upnp/profiles/S/actions/S/arguments/N/state_id/
The identifier of the state variable to which the argument is related, if any
Related state variable identifier, if anyNo related state variableRelated state variable identifier
Protect network settingsProtectedNot protected
can_write
State variables[element]:State variable binding
check
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum is a part of a composite value which is modified as a whole.
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null No related state variable The argument isn't related to a state variable
string Related state variable identifier The identifier of the state vari-able to which the argument is re-lated
state variables[the value]
Sample curl write command (note that :upnp_device_profile, :action and :argument_index areURL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "\"BinaryState\"" "http ←↩↪→ ://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/actions/:action ←↩↪→ /arguments/:argument_index/state_id/"
Sample requests read command (note that _upnp_device_profile, _action and _argument_←↩
index are variables):
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 605
print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+ ←↩↪→ _upnp_device_profile+'/actions/'+_action+'/arguments/'+str(_argument_index) ←↩↪→ +'/state_id/',auth=auth,headers=headers).json())
⇒'FriendlyName'
Browse more samples
10.23 UPnP device profile: Action map
map upnp/profiles/S/actions/
Map of actions that can be performed on the outlet
Actionarguments:Argumentscode:Code
Action map[element]:Action
0..*
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This map is composite, i.e. is modified as a whole.
This map represents a value in persistent storage.
This map contains Action elements.
Sample curl read command (note that :upnp_device_profile is a URL template argument):
DLI V222 Object Model Reference: 20210317T201932Z
606 CONTENTS
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/profiles/:upnp_device_profile/actions/"
⇒
Sample JS request action creation command (note that _upnp_device_profile is a variable):
request.put({url:"upnp/profiles/"+_upnp_device_profile+"/actions/GetBinaryState ←↩↪→ /",body:{"code":"function(outlet) return outlet.state end","arguments":[{" ←↩↪→ is_output":true,"state_id":"BinaryState","name":"BinaryState","type":" ←↩↪→ Boolean"}]}});
Browse more samples
10.23.1 Action
object upnp/profiles/S/actions/S/
Action properties
Arguments[element]:Argument
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Actionarguments:Argumentscode:Code
The value is subject to the following constraints: index of the value matches ∧[a-zA-Z_][a-zA-Z_0-9]∗$
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
arguments Arguments
code Code
Sample CLI read command (note that upnp_device_profile and action are variables):
uom get "upnp/profiles/${upnp_device_profile}/actions/${action}"
⇒{"code":"function(outlet,value) outlet.state=value end","arguments":[{"is_output ←↩
↪→ ":false,"state_id":"BinaryState","name":"BinaryState","type":"Boolean"}]}
Sample requests deletion command (note that _upnp_device_profile and _action are variables):
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 607
requests.delete('http://192.168.0.100/restapi/upnp/profiles/'+ ←↩↪→ _upnp_device_profile+'/actions/'+_action+'/',auth=auth,headers=headers)
Browse more samples
10.23.1.1 Arguments
array upnp/profiles/S/actions/S/arguments/
Action input and output arguments
Argumentname:Argument nametype:Argument typeis_output:Output/return value flagstate_id:Related state variable identifier, if any
Arguments[element]:Argument
0..*
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This array is a part of a composite value which is modified as a whole.
This array represents a value in persistent storage.
This array contains Argument elements.
Sample uom library argument creation command (note that _upnp_device_profile and _action arevariables):
local composite=uom.copy(uom.upnp.profiles[_upnp_device_profile].actions)uom.insert(composite[_action].arguments,1,{is_output=true,name="FriendlyName", ←↩
↪→ state_id="FriendlyName",type="string"})uom.upnp.profiles[_upnp_device_profile].actions=composite
DLI V222 Object Model Reference: 20210317T201932Z
608 CONTENTS
Sample curl read command (note that :upnp_device_profile and :action are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/profiles/:upnp_device_profile/actions/:action/arguments/"
⇒[{"is_output":false,"state_id":"BinaryState","name":"BinaryState","type":"Boolean ←↩
↪→ "}]
Browse more samples
See also Arguments: Argument
10.23.1.2 Code
string upnp/profiles/S/actions/S/code/
Code of Lua function to perform the action
Code
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample curl write command (note that :upnp_device_profile and :action are URL templatearguments):
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 609
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "\"function(outlet) ←↩↪→ return outlet.state end\"" "http://192.168.0.100/restapi/upnp/profiles/: ←↩↪→ upnp_device_profile/actions/:action/code/"
Sample uom library read command (note that _upnp_device_profile and _action are variables):
print(uom.dump(uom.upnp.profiles[_upnp_device_profile].actions[_action].code))
⇒"function(outlet) return outlet.state end"
Browse more samples
10.24 UPnP device profile: SOAP XML namespace prefix override, if any
sum (optional string) upnp/profiles/S/soap_xmlns_prefix_override/
SOAP XML namespace prefix to use on encoding instead of the default one (for compatibility), if any
SOAP XML namespace prefix override, if anyNoneSOAP XML namespace prefix override
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null None Use the default SOAP XML namespace prefix('soap11')
string SOAP XML namespace prefixoverride
SOAP XML namespace prefixto use on encoding instead ofthe default one (for compati-bility)
the value matches ∧([A-←↩
Za-z_][A-Za-z0-9_-]?|[A-←↩
WYZa-wyz_][A-Za-z0-9←↩
_-]{2,}|[xX][A-LN-Za-ln-z0-9_-][A-Za-z0-9_←↩
-]{1,}|[xX][mM][A-KM-Za-km-z0-9_-][A-Za-z0-9_-]∗)$
DLI V222 Object Model Reference: 20210317T201932Z
610 CONTENTS
Sample curl read command (note that :upnp_device_profile is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/profiles/:upnp_device_profile/soap_xmlns_prefix_override/"
⇒"Uf2JJJQP"
Sample JS request write command (note that _upnp_device_profile is a variable):
request.put({url:"upnp/profiles/"+_upnp_device_profile+"/ ←↩↪→ soap_xmlns_prefix_override/",body:"XbM"});
Browse more samples
10.25 UPnP device profile: Service XML namespace prefix override, if any
sum (optional string) upnp/profiles/S/service_xmlns_prefix_override/
Service XML namespace prefix to use on encoding instead of the default one (for compatibility), if any
Service XML namespace prefix override, if anyNoneService XML namespace prefix override
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null None Use the default service XML namespace prefix ('svc')
string Service XML namespace pre-fix override
Service XML namespace pre-fix to use on encoding insteadof the default one (for compat-ibility)
the value matches ∧([A-←↩
Za-z_][A-Za-z0-9_-]?|[A-←↩
WYZa-wyz_][A-Za-z0-9←↩
_-]{2,}|[xX][A-LN-Za-ln-z0-9_-][A-Za-z0-9_←↩
-]{1,}|[xX][mM][A-KM-Za-km-z0-9_-][A-Za-z0-9_-]∗)$
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 611
Sample JS request write command (note that _upnp_device_profile is a variable):
request.put({url:"upnp/profiles/"+_upnp_device_profile+"/ ←↩↪→ service_xmlns_prefix_override/",body:null});
Sample curl read command (note that :upnp_device_profile is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/profiles/:upnp_device_profile/service_xmlns_prefix_override/"
⇒"xm4o"
Browse more samples
10.26 UPnP device profile: Event XML namespace prefix override, if any
sum (optional string) upnp/profiles/S/event_xmlns_prefix_override/
Event XML namespace prefix to use on encoding instead of the default one (for compatibility), if any
Event XML namespace prefix override, if anyNoneEvent XML namespace prefix override
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null None Use the default event XML namespace prefix ('event')
string Event XML namespace prefixoverride
Event XML namespace prefixto use on encoding instead ofthe default one (for compati-bility)
the value matches ∧([A-←↩
Za-z_][A-Za-z0-9_-]?|[A-←↩
WYZa-wyz_][A-Za-z0-9←↩
_-]{2,}|[xX][A-LN-Za-ln-z0-9_-][A-Za-z0-9_←↩
-]{1,}|[xX][mM][A-KM-Za-km-z0-9_-][A-Za-z0-9_-]∗)$
DLI V222 Object Model Reference: 20210317T201932Z
612 CONTENTS
Sample uom library write command (note that _upnp_device_profile is a variable):
uom.upnp.profiles[_upnp_device_profile].event_xmlns_prefix_override=null
Sample CLI write command (note that upnp_device_profile is a variable):
uom set "upnp/profiles/${upnp_device_profile}/event_xmlns_prefix_override" "\"kxD ←↩↪→ \""
Browse more samples
10.27 Notifications
object upnp/notifications/
UPnP-related notifications
Parameter kinds
check
Events[element]:Event
Administrative userAdministratorRegular user
can_readNotificationsparameter_kinds:Parameter kindsevents:Events
can_read
Retrieving the value is denied if not administrative user
This object does not support direct modification.
This object contains the following items:
parameter_kinds Parameter kinds
events Events
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/notifications/"
⇒
{"events":{"dli.upnp.sample_event":{"parameters":[{"id":"sample_parameter"," ←↩↪→ has_fixed_value":false,"fixed_value":null}],"message_template":["sample ←↩↪→ event"]}},"parameter_kinds":[]}
Sample requests read command:
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 613
print(requests.get('http://192.168.0.100/restapi/upnp/notifications/',auth=auth, ←↩↪→ headers=headers).json())
⇒{'events': {'dli.upnp.sample_event': {'parameters': [{'id': 'sample_parameter', ' ←↩
↪→ has_fixed_value': False, 'fixed_value': None}], 'message_template': [' ←↩↪→ sample event']}}, 'parameter_kinds': {}}
Browse more samples
10.27.1 Parameter kinds
object upnp/notifications/parameter_kinds/
Kinds of event parameters
This object does not correspond to an actual resource.
This object is empty.
10.27.2 Events
map upnp/notifications/events/
Event templates
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
Events[element]:Event
0..*
Administrative userAdministratorRegular user
can_read
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.
DLI V222 Object Model Reference: 20210317T201932Z
614 CONTENTS
This map contains Event elements.
Creating elements in this collection is not supported.
Sample CLI read command:
uom get "upnp/notifications/events"
⇒{"dli.upnp.sample_event":{"parameters":[{"id":"sample_parameter","has_fixed_value ←↩
↪→ ":false,"fixed_value":null}],"message_template":["sample event"]}}
Sample uom library read command:
print(uom.dump(uom.upnp.notifications.events))
⇒{dli.upnp.sample_event={message_template={"sample event"},parameters={{ ←↩
↪→ fixed_value=null,has_fixed_value=false,id="sample_parameter"}}}}
Browse more samples
See also Events: Event
10.28 Event parameters: Event parameter
object upnp/notifications/events/S/parameters/N/
Properties of a parameter associated with the event
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
id Identifierhas_fixed_value Fixed value flag
fixed_value Fixed value
Sample uom library write command (note that _event and _event_parameter_index are variables):
uom.upnp.notifications.events[_event].parameters[_event_parameter_index]={ ←↩↪→ fixed_value=null,has_fixed_value=false,id="sample_parameter"}
Sample requests write command (note that _event and _event_parameter_index are variables):
requests.put('http://192.168.0.100/restapi/upnp/notifications/events/'+_event+'/ ←↩↪→ parameters/'+str(_event_parameter_index)+'/',auth=auth,headers=headers,json ←↩↪→ ={'id': 'sample_parameter', 'has_fixed_value': False, 'fixed_value': None})
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 615
10.28.1 Identifier
string upnp/notifications/events/S/parameters/N/id/
Parameter identifier
Identifier
Parameter kindscheck
Administrative userAdministratorRegular user
can_read
The value is subject to the following constraints: parameter kinds[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 _event and _event_parameter_index are variables):
request.get({url:"upnp/notifications/events/"+_event+"/parameters/"+ ←↩↪→ _event_parameter_index.toString()+"/id/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"sample_parameter"
Sample curl read command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/notifications/events/:event/parameters/:event_parameter_index/ ←↩↪→ id/"
⇒"sample_parameter"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
616 CONTENTS
10.28.2 Fixed value flag
sum (boolean) upnp/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
Fixed value flagFixedVariable
Administrative userAdministratorRegular user
can_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 Fixed The value is fixedconstant false Variable The value is variable
Sample curl read command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/notifications/events/:event/parameters/:event_parameter_index/ ←↩↪→ has_fixed_value/"
⇒false
Sample requests read command (note that _event and _event_parameter_index are variables):
print(requests.get('http://192.168.0.100/restapi/upnp/notifications/events/'+ ←↩↪→ _event+'/parameters/'+str(_event_parameter_index)+'/has_fixed_value/',auth= ←↩↪→ auth,headers=headers).json())
⇒False
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 617
10.28.3 Fixed value
sum (variant) upnp/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
Fixed valueNullTrueFalseStringNumber
Administrative userAdministratorRegular user
can_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 null Null Nullconstant true True Trueconstant false False Falsestring String This string
number Number This number
Sample requests read command (note that _event and _event_parameter_index are variables):
print(requests.get('http://192.168.0.100/restapi/upnp/notifications/events/'+ ←↩↪→ _event+'/parameters/'+str(_event_parameter_index)+'/fixed_value/',auth=auth ←↩↪→ ,headers=headers).json())
⇒None
Sample CLI read command (note that event and event_parameter_index are variables):
uom get "upnp/notifications/events/${event}/parameters/${event_parameter_index}/ ←↩↪→ fixed_value"
DLI V222 Object Model Reference: 20210317T201932Z
618 CONTENTS
⇒null
Browse more samples
10.29 Events: Event
object upnp/notifications/events/S/
Event template
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
can_readcheck
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
message_template Message template
severity Severity
parameters Event parameters
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.upnp.notifications.events[_event]))
⇒{message_template={"sample event"},parameters={{fixed_value=null,has_fixed_value= ←↩
↪→ false,id="sample_parameter"}}}
Sample uom library write command (note that _event is a variable):
uom.upnp.notifications.events[_event]={message_template={"sample event"}, ←↩↪→ parameters={{fixed_value=null,has_fixed_value=false,id="sample_parameter ←↩↪→ "}}}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 619
10.29.1 Message template
array upnp/notifications/events/S/message_template/
Template for human-readable message generation
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Message template element elements.
Creating elements in this collection is not supported.
Sample JS request read command (note that _event is a variable):
request.get({url:"upnp/notifications/events/"+_event+"/message_template/"}, ←↩↪→ function(error,response,body) {console.log(body)});
⇒["sample event"]
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/upnp/notifications/events/'+ ←↩↪→ _event+'/message_template/',auth=auth,headers=headers).json())
⇒['sample event']
Browse more samples
10.29.1.1 Message template element
sum (variant) upnp/notifications/events/S/message_template/N/
Element of human-readable message template
DLI V222 Object Model Reference: 20210317T201932Z
620 CONTENTS
Message template elementStringParameter
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
check
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:
string String Fixed string
number Parameter Index of message parameter to insert event parameters[the value]
Sample requests read command (note that _event and _message_template_element_index arevariables):
print(requests.get('http://192.168.0.100/restapi/upnp/notifications/events/'+ ←↩↪→ _event+'/message_template/'+str(_message_template_element_index)+'/',auth= ←↩↪→ auth,headers=headers).json())
⇒'sample event'
Sample curl read command (note that :event and :message_template_element_index are URLtemplate arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/upnp/notifications/events/:event/message_template/: ←↩↪→ message_template_element_index/"
⇒"sample event"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
10 UPnP server object 621
10.29.2 Severity
sum (enumerated number) upnp/notifications/events/S/severity/
Severity rating assigned to the event
SeverityEmergencyAlertCriticalErrorWarningNoticeInformationalDebug
Administrative userAdministratorRegular user
can_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 1 Emergency Treat the event as an emergency
constant 2 Alert Treat the event as an alertconstant 3 Critical Treat the event as criticalconstant 4 Error Treat the event as an errorconstant 5 Warning Treat the event as a warning
constant 6 Notice Treat the event as a noticeconstant 7 Informational Treat the event as informationalconstant 8 Debug Treat the event as debugging-related
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/upnp/notifications/events/'+ ←↩↪→ _event+'/severity/',auth=auth,headers=headers).json())
DLI V222 Object Model Reference: 20210317T201932Z
622 CONTENTS
⇒{}
Sample JS request read command (note that _event is a variable):
request.get({url:"upnp/notifications/events/"+_event+"/severity/"},function(error ←↩↪→ ,response,body) {console.log(body)});
⇒[]
Browse more samples
10.29.3 Event parameters
array upnp/notifications/events/S/parameters/
Additional data associated with the event
Event parameterid:Identifierhas_fixed_value:Fixed value flagfixed_value:Fixed value
Event parameters[element]:Event parameter
0..*
check Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Event parameter elements.
Creating elements in this collection is not supported.
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/upnp/notifications/events/'+ ←↩↪→ _event+'/parameters/',auth=auth,headers=headers).json())
⇒
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 623
[{'id': 'sample_parameter', 'has_fixed_value': False, 'fixed_value': None}]
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.upnp.notifications.events[_event].parameters))
⇒{{fixed_value=null,has_fixed_value=false,id="sample_parameter"}}
Browse more samples
See also Event parameters: Event parameter
11 MQTT client object
object mqtt/
Object representing the MQTT client configuration
Outlet MQTT configuration settings[element]:Outlet MQTT configuration
Administrative userAdministratorRegular user
can_read,can_write
Outlets[element]:Outlet
check
Protect network settingsProtectedNot protected
can_write
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
MQTT client objectenabled:Enabledoutlets:Outlet MQTT configuration settingsbroker_address:MQTT broker addressbroker_port:MQTT broker port, if anyuse_ssl:Use SSLusername:Usernamepassword:Passwordtopic_root:Topic rootconnect_topic:Connection message topicconnect_payload:Connection message payloadconnect_qos:Connection message QoSconnect_retain:Connection message retain flagreconnect_topic:Reconnection message topicreconnect_payload:Reconnection message payloadreconnect_qos:Reconnection message QoSreconnect_retain:Reconnection message retain flagdisconnect_topic:Disconnection message topicdisconnect_payload:Disconnection message payloaddisconnect_qos:Disconnection message QoSdisconnect_retain:Disconnection message retain flaglwt_topic:Last Will and Testament topiclwt_payload:Last Will and Testament payloadlwt_qos:Last Will and Testament QoSlwt_retain:Last Will and Testament retain flagnotifications:Notifications
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
enabled Enabledoutlets Outlet MQTT configuration settings
broker_address MQTT broker address
DLI V222 Object Model Reference: 20210317T201932Z
624 CONTENTS
broker_port MQTT broker port, if any
use_ssl Use SSLusername Usernamepassword Password
topic_root Topic root
connect_topic Connection message topic
connect_payload Connection message payload
connect_qos Connection message QoS
connect_retain Connection message retain flag
reconnect_topic Reconnection message topic
reconnect_payload Reconnection message payload
reconnect_qos Reconnection message QoS
reconnect_retain Reconnection message retain flag
disconnect_topic Disconnection message topic
disconnect_payload Disconnection message payload
disconnect_qos Disconnection message QoS
disconnect_retain Disconnection message retain flag
lwt_topic Last Will and Testament topic
lwt_payload Last Will and Testament payload
lwt_qos Last Will and Testament QoS
lwt_retain Last Will and Testament retain flag
notifications Notifications
Sample CLI read command:
uom get mqtt
⇒...
Sample requests write command:
requests.put('http://192.168.0.100/restapi/mqtt/',auth=auth,headers=headers,json ←↩↪→ =<...>)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 625
11.1 Enabled
sum (boolean) mqtt/enabled/
MQTT client enable status
EnabledEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample CLI write command:
uom set "mqtt/enabled" "false"
Sample CLI read command:
uom get "mqtt/enabled"
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
626 CONTENTS
11.2 Outlet MQTT configuration settings
array mqtt/outlets/
Properties related to exposing outlets via MQTT
Outlet MQTT configurationtopic_subtree:Topic subtree, if anyallow_read:Allow readallow_write:Allow writeqos:State subscription and report QoS
Outlets[element]:Outletcheck
Outlet MQTT configuration settings[element]:Outlet MQTT configuration
0..*
check
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
The value is subject to the following constraints: length of the value is equal to length of outlets
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This array represents a value in persistent storage.
This array contains Outlet MQTT configuration elements.
Sample uom library outlet MQTT configuration creation command:
uom.insert(uom.mqtt.outlets,5,{allow_read=false,allow_write=true,qos=0, ←↩↪→ topic_subtree="miF4m"})
Sample requests outlet MQTT configuration creation command:
requests.post('http://192.168.0.100/restapi/mqtt/outlets/',auth=auth,headers= ←↩↪→ headers,json={'allow_read': False, 'topic_subtree': 'Buj15NR', 'qos': 2, ' ←↩↪→ allow_write': True})
Browse more samples
See also Outlet MQTT configuration settings: Outlet MQTT configuration
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 627
11.3 Outlet MQTT configuration settings: Outlet MQTT configuration
object mqtt/outlets/N/
Properties related to exposing the outlet via MQTT
Outlet MQTT configurationtopic_subtree:Topic subtree, if anyallow_read:Allow readallow_write:Allow writeqos:State subscription and report QoS
Outlets[element]:Outlet
check
The value is subject to the following constraints: outlets[index of the value]
This object contains the following items:
topic_subtree Topic subtree, if any
allow_read Allow readallow_write Allow writeqos State subscription and report QoS
Sample curl read command (note that :outlet_mqtt_configuration_index is a URL templateargument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/mqtt/outlets/:outlet_mqtt_configuration_index/"
⇒{"allow_read":false,"topic_subtree":"OR1kFJmxUi","qos":0,"allow_write":true}
Sample CLI read command (note that outlet_mqtt_configuration_index is a variable):
uom get "mqtt/outlets/${outlet_mqtt_configuration_index}"
⇒{"allow_read":true,"topic_subtree":"OJjRmZ","qos":2,"allow_write":false}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
628 CONTENTS
11.3.1 Topic subtree, if any
sum (optional string) mqtt/outlets/N/topic_subtree/
MQTT topic subtree (relative to the topic root), if any
Topic subtree, if anyOutlet index-basedTopic subtree
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Outlet index-based Use 'outlets/'+the 0-based outlet index as topic subtree
string Topic subtree MQTT topic subtree (relative to the topic root)
Sample uom library write command (note that _outlet_mqtt_configuration_index is a variable):
uom.mqtt.outlets[_outlet_mqtt_configuration_index].topic_subtree="VuaoT"
Sample uom library read command (note that _outlet_mqtt_configuration_index is a variable):
print(uom.dump(uom.mqtt.outlets[_outlet_mqtt_configuration_index].topic_subtree))
⇒"R7hbcz"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 629
11.3.2 Allow read
sum (boolean) mqtt/outlets/N/allow_read/
Outlet state is broadcasted via MQTT
Allow readEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample JS request read command (note that _outlet_mqtt_configuration_index is a variable):
request.get({url:"mqtt/outlets/"+_outlet_mqtt_configuration_index.toString()+"/ ←↩↪→ allow_read/"},function(error,response,body) {console.log(body)});
⇒
true
Sample uom library read command (note that _outlet_mqtt_configuration_index is a variable):
print(uom.dump(uom.mqtt.outlets[_outlet_mqtt_configuration_index].allow_read))
DLI V222 Object Model Reference: 20210317T201932Z
630 CONTENTS
⇒false
Browse more samples
11.3.3 Allow write
sum (boolean) mqtt/outlets/N/allow_write/
Outlet state can be changed via MQTT
Allow writeEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample CLI write command (note that outlet_mqtt_configuration_index is a variable):
uom set "mqtt/outlets/${outlet_mqtt_configuration_index}/allow_write" "true"
Sample curl read command (note that :outlet_mqtt_configuration_index is a URL templateargument):
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 631
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/mqtt/outlets/:outlet_mqtt_configuration_index/allow_write/"
⇒true
Browse more samples
11.3.4 State subscription and report QoS
sum (enumerated number) mqtt/outlets/N/qos/
Quality of service when subscribing to and broadcasting outlet state
State subscription and report QoSAt most onceAt least onceExactly once
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant 0 At most once Message should be delivered at most once
constant 1 At least once Message should be delivered at least once
constant 2 Exactly once Message should be delivered exactly once
Sample JS request write command (note that _outlet_mqtt_configuration_index is a variable):
request.put({url:"mqtt/outlets/"+_outlet_mqtt_configuration_index.toString()+"/ ←↩↪→ qos/",body:1});
DLI V222 Object Model Reference: 20210317T201932Z
632 CONTENTS
Sample JS request read command (note that _outlet_mqtt_configuration_index is a variable):
request.get({url:"mqtt/outlets/"+_outlet_mqtt_configuration_index.toString()+"/ ←↩↪→ qos/"},function(error,response,body) {console.log(body)});
⇒0
Browse more samples
11.4 MQTT broker address
sum (string) mqtt/broker_address/
Host name or IPv4 address of the MQTT broker to connect to
MQTT broker addressHostnameIPv4 address
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
string Hostname Hostname the value matches ∧(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]∗[a-zA-Z0-9]).)∗([A-Za-z]([A-←↩
Za-z0-9-]∗[A-Za-z0-9])?|[A-Za-z0-9][A-Za-z0-9-]∗[A-Za-z]([A-Za-z0-9-]∗[A-Za-z0-9])?)$
string IPv4 address IPv4 address in dotted quad notation the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 633
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 "\"253.48.187.8\"" "http ←↩↪→ ://192.168.0.100/restapi/mqtt/broker_address/"
Sample CLI write command:
uom set "mqtt/broker_address" "\"A6Oi.Fb0Mm.example.com\""
Browse more samples
11.5 MQTT broker port, if any
sum (optional number) mqtt/broker_port/
Port of the MQTT broker to connect to, if any
MQTT broker port, if anyUse default portMQTT broker port
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null Use default port Connect to port 1883 when SSL is not used, port 8883if SSL is used
number MQTT broker port Port of the MQTT broker to connect to all of the following is true:
• the value is an integer
• the value is greater than 0
• the value is less than 65535DLI V222 Object Model Reference: 20210317T201932Z
634 CONTENTS
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/mqtt/broker_port/',auth=auth, ←↩↪→ headers=headers).json())
⇒None
Sample CLI write command:
uom set "mqtt/broker_port" "null"
Browse more samples
11.6 Use SSL
sum (boolean) mqtt/use_ssl/
Use SSL when connecting to the MQTT broker
Use SSLEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 635
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample uom library read command:
print(uom.dump(uom.mqtt.use_ssl))
⇒true
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/mqtt/use_ssl/"
⇒true
Browse more samples
11.7 Username
string mqtt/username/
Username to use when connecting to the MQTT broker
Username
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
DLI V222 Object Model Reference: 20210317T201932Z
636 CONTENTS
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample JS request read command:
request.get({url:"mqtt/username/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒"userFNgvL"
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/mqtt/username/',auth=auth, ←↩↪→ headers=headers).json())
⇒'userhO8LN'
Browse more samples
11.8 Password
string mqtt/password/
Password to use when connecting to the MQTT broker
Password
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 637
• not administrative user
• protect network settings
This string represents a value in persistent storage.
This string should be displayed in a secure manner.
Sample CLI read command:
uom get "mqtt/password"
⇒"%^Y15^Ut"
Sample uom library write command:
uom.mqtt.password="/VN/E1$YhN."
Browse more samples
11.9 Topic root
string mqtt/topic_root/
Topic root to use for all messages
Topic root
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
638 CONTENTS
• protect network settings
This string represents a value in persistent storage.
Sample CLI read command:
uom get "mqtt/topic_root"
⇒"tv71Mi"
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 "\"2rLIJvZdK\"" "http ←↩↪→ ://192.168.0.100/restapi/mqtt/topic_root/"
Browse more samples
11.10 Connection message topic
string mqtt/connect_topic/
Topic of the message to send on initial connection to broker (not relative to the topic root)
Connection message topic
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample JS request write command:
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 639
request.put({url:"mqtt/connect_topic/",body:"oQiuSXx"});
Sample CLI write command:
uom set "mqtt/connect_topic" "\"WYPK\""
Browse more samples
11.11 Connection message payload
string mqtt/connect_payload/
Payload of the message to send on initial connection to broker
Connection message payload
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample JS request write command:
request.put({url:"mqtt/connect_payload/",body:"bCXtL"});
Sample uom library write command:
uom.mqtt.connect_payload="Dj"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
640 CONTENTS
11.12 Connection message QoS
sum (enumerated number) mqtt/connect_qos/
Quality of service for the message to send on initial connection to broker
Connection message QoSAt most onceAt least onceExactly once
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant 0 At most once Message should be delivered at most once
constant 1 At least once Message should be delivered at least once
constant 2 Exactly once Message should be delivered exactly once
Sample CLI write command:
uom set "mqtt/connect_qos" "1"
Sample uom library write command:
uom.mqtt.connect_qos=1
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 641
11.13 Connection message retain flag
sum (boolean) mqtt/connect_retain/
Flag indicating whether the message to be sent on initial connection to broker should be retained
Connection message retain flagRetainedNot retained
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Retained The latest message payload should be retained on thebroker and sent on subscription
constant false Not retained Messages should not be retained on the broker
Sample requests write command:
requests.put('http://192.168.0.100/restapi/mqtt/connect_retain/',auth=auth, ←↩↪→ headers=headers,json=False)
Sample CLI write command:
uom set "mqtt/connect_retain" "false"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
642 CONTENTS
11.14 Reconnection message topic
string mqtt/reconnect_topic/
Topic of the message to send on reconnection to broker (not relative to the topic root)
Reconnection message topic
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample JS request read command:
request.get({url:"mqtt/reconnect_topic/"},function(error,response,body) {console. ←↩↪→ log(body)});
⇒"oPycumw0"
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 "\"YlzeNkHFVZ\"" "http ←↩↪→ ://192.168.0.100/restapi/mqtt/reconnect_topic/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 643
11.15 Reconnection message payload
string mqtt/reconnect_payload/
Payload of the message to send on reconnection to broker
Reconnection message payload
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI read command:
uom get "mqtt/reconnect_payload"
⇒"Z"
Sample JS request read command:
request.get({url:"mqtt/reconnect_payload/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"RJ95"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
644 CONTENTS
11.16 Reconnection message QoS
sum (enumerated number) mqtt/reconnect_qos/
Quality of service for the message to send on reconnection to broker
Reconnection message QoSAt most onceAt least onceExactly once
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant 0 At most once Message should be delivered at most once
constant 1 At least once Message should be delivered at least once
constant 2 Exactly once Message should be delivered exactly once
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/mqtt/reconnect_qos/"
⇒0
Sample JS request read command:
request.get({url:"mqtt/reconnect_qos/"},function(error,response,body) {console. ←↩↪→ log(body)});
⇒2
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 645
11.17 Reconnection message retain flag
sum (boolean) mqtt/reconnect_retain/
Flag indicating whether the message to be sent on reconnection to broker should be retained
Reconnection message retain flagRetainedNot retained
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Retained The latest message payload should be retained on thebroker and sent on subscription
constant false Not retained Messages should not be retained on the broker
Sample CLI write command:
uom set "mqtt/reconnect_retain" "true"
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/mqtt/reconnect_retain/"
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
646 CONTENTS
11.18 Disconnection message topic
string mqtt/disconnect_topic/
Topic of the message to send before disconnecting from broker (not relative to the topic root)
Disconnection message topic
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample JS request read command:
request.get({url:"mqtt/disconnect_topic/"},function(error,response,body) {console ←↩↪→ .log(body)});
⇒"EmjWi"
Sample uom library read command:
print(uom.dump(uom.mqtt.disconnect_topic))
⇒"btjA"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 647
11.19 Disconnection message payload
string mqtt/disconnect_payload/
Payload of the message to send before disconnecting from broker
Disconnection message payload
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample requests write command:
requests.put('http://192.168.0.100/restapi/mqtt/disconnect_payload/',auth=auth, ←↩↪→ headers=headers,json='H')
Sample JS request read command:
request.get({url:"mqtt/disconnect_payload/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"pV5"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
648 CONTENTS
11.20 Disconnection message QoS
sum (enumerated number) mqtt/disconnect_qos/
Quality of service for the message to send before disconnecting from broker
Disconnection message QoSAt most onceAt least onceExactly once
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant 0 At most once Message should be delivered at most once
constant 1 At least once Message should be delivered at least once
constant 2 Exactly once Message should be delivered exactly once
Sample requests write command:
requests.put('http://192.168.0.100/restapi/mqtt/disconnect_qos/',auth=auth, ←↩↪→ headers=headers,json=1)
Sample JS request read command:
request.get({url:"mqtt/disconnect_qos/"},function(error,response,body) {console. ←↩↪→ log(body)});
⇒2
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 649
11.21 Disconnection message retain flag
sum (boolean) mqtt/disconnect_retain/
Flag indicating whether the message to be sent before disconnecting from broker should be retained
Disconnection message retain flagRetainedNot retained
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Retained The latest message payload should be retained on thebroker and sent on subscription
constant false Not retained Messages should not be retained on the broker
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/mqtt/disconnect_retain/',auth= ←↩↪→ auth,headers=headers).json())
⇒False
Sample CLI read command:
uom get "mqtt/disconnect_retain"
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
650 CONTENTS
11.22 Last Will and Testament topic
string mqtt/lwt_topic/
Topic of the message for the broker to send if the unit goes offline unexpectedly (not relative to the topic root)
Last Will and Testament topic
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI write command:
uom set "mqtt/lwt_topic" "\"VU/lp\""
Sample JS request read command:
request.get({url:"mqtt/lwt_topic/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒"hSuIOXhA"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 651
11.23 Last Will and Testament payload
string mqtt/lwt_payload/
Payload of the message for the broker to send if the unit goes offline unexpectedly
Last Will and Testament payload
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This string represents a value in persistent storage.
Sample CLI read command:
uom get "mqtt/lwt_payload"
⇒"c"
Sample uom library read command:
print(uom.dump(uom.mqtt.lwt_payload))
⇒"8al"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
652 CONTENTS
11.24 Last Will and Testament QoS
sum (enumerated number) mqtt/lwt_qos/
Quality of service for the message for the broker to send if the unit goes offline unexpectedly
Last Will and Testament QoSAt most onceAt least onceExactly once
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant 0 At most once Message should be delivered at most once
constant 1 At least once Message should be delivered at least once
constant 2 Exactly once Message should be delivered exactly once
Sample JS request read command:
request.get({url:"mqtt/lwt_qos/"},function(error,response,body) {console.log(body ←↩↪→ )});
⇒1
Sample uom library read command:
print(uom.dump(uom.mqtt.lwt_qos))
⇒2
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 653
11.25 Last Will and Testament retain flag
sum (boolean) mqtt/lwt_retain/
Flag indicating whether the message to be sent if the unit goes offline unexpectedly should be retained
Last Will and Testament retain flagRetainedNot retained
Administrative userAdministratorRegular user
can_read,can_write
Protect network settingsProtectedNot protected
can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
• not administrative user
• protect network settings
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Retained The latest message payload should be retained on thebroker and sent on subscription
constant false Not retained Messages should not be retained on the broker
Sample requests write command:
requests.put('http://192.168.0.100/restapi/mqtt/lwt_retain/',auth=auth,headers= ←↩↪→ headers,json=True)
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 "false" "http ←↩↪→ ://192.168.0.100/restapi/mqtt/lwt_retain/"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
654 CONTENTS
11.26 Notifications
object mqtt/notifications/
MQTT-related notifications
Parameter kindsconnected:Connection status
check
Events[element]:Event
Administrative userAdministratorRegular user
can_readNotificationsparameter_kinds:Parameter kindsevents:Events
can_read
Retrieving the value is denied if not administrative user
This object does not support direct modification.
This object contains the following items:
parameter_kinds Parameter kinds
events Events
Sample JS request read command:
request.get({url:"mqtt/notifications/"},function(error,response,body) {console. ←↩↪→ log(body)});
⇒
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/',auth=auth, ←↩↪→ headers=headers).json())
⇒
Browse more samples
See also Notifications: Parameter kinds
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 655
11.26.1 Events
map mqtt/notifications/events/
Event templates
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
Events[element]:Event
0..*
Administrative userAdministratorRegular user
can_read
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 Event 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/mqtt/notifications/events/"
⇒
Sample JS request read command:
request.get({url:"mqtt/notifications/events/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒
Browse more samples
See also Events: Event
DLI V222 Object Model Reference: 20210317T201932Z
656 CONTENTS
11.27 Notifications: Parameter kinds
object mqtt/notifications/parameter_kinds/
Kinds of event parameters
This object does not correspond to an actual resource.
This object contains the following items:
connected Connection status
11.27.1 Connection status
sum (boolean) mqtt/notifications/parameter_kinds/connected/
Broker connection status
This sum can assume the following values:
constant true Connected Broker connection successfulconstant false Failed to connect Broker connection failed
11.28 Event parameters: Event parameter
object mqtt/notifications/events/S/parameters/N/
Properties of a parameter associated with the event
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
id Identifierhas_fixed_value Fixed value flag
fixed_value Fixed value
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.mqtt.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index]))
⇒
{fixed_value=false,has_fixed_value=true,id="connected"}
Sample requests read command (note that _event and _event_parameter_index are variables):
print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+ ←↩↪→ _event+'/parameters/'+str(_event_parameter_index)+'/',auth=auth,headers= ←↩↪→ headers).json())
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 657
⇒{'fixed_value': True, 'has_fixed_value': True, 'id': 'connected'}
Browse more samples
11.28.1 Identifier
string mqtt/notifications/events/S/parameters/N/id/
Parameter identifier
Identifier
Parameter kindsconnected:Connection status
check
Administrative userAdministratorRegular user
can_read
The value is subject to the following constraints: parameter kinds[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 requests read command (note that _event and _event_parameter_index are variables):
print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+ ←↩↪→ _event+'/parameters/'+str(_event_parameter_index)+'/id/',auth=auth,headers= ←↩↪→ headers).json())
⇒'connected'
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.mqtt.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].id))
⇒"connected"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
658 CONTENTS
11.28.2 Fixed value flag
sum (boolean) mqtt/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
Fixed value flagFixedVariable
Administrative userAdministratorRegular user
can_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 Fixed The value is fixedconstant false Variable The value is variable
Sample requests read command (note that _event and _event_parameter_index are variables):
print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+ ←↩↪→ _event+'/parameters/'+str(_event_parameter_index)+'/has_fixed_value/',auth= ←↩↪→ auth,headers=headers).json())
⇒True
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.mqtt.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].has_fixed_value))
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 659
11.28.3 Fixed value
sum (variant) mqtt/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
Fixed valueNullTrueFalseStringNumber
Administrative userAdministratorRegular user
can_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 null Null Nullconstant true True Trueconstant false False Falsestring String This string
number Number This number
Sample curl read command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/mqtt/notifications/events/:event/parameters/:event_parameter_index/ ←↩↪→ fixed_value/"
⇒
false
Sample CLI read command (note that event and event_parameter_index are variables):
DLI V222 Object Model Reference: 20210317T201932Z
660 CONTENTS
uom get "mqtt/notifications/events/${event}/parameters/${event_parameter_index}/ ←↩↪→ fixed_value"
⇒false
Browse more samples
11.29 Events: Event
object mqtt/notifications/events/S/
Event template
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
can_readcheck
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
message_template Message template
severity Severity
parameters Event parameters
Sample CLI write command (note that event is a variable):
uom set "mqtt/notifications/events/${event}" "{\"severity\":5,\"message_template ←↩↪→ \":[\"failed to connect to broker\"],\"parameters\":[{\"fixed_value\":false ←↩↪→ ,\"has_fixed_value\":true,\"id\":\"connected\"}]}"
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.mqtt.notifications.events[_event]))
⇒{message_template={"failed to connect to broker"},parameters={{fixed_value=false, ←↩
↪→ has_fixed_value=true,id="connected"}},severity=5}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 661
11.29.1 Message template
array mqtt/notifications/events/S/message_template/
Template for human-readable message generation
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Message template element elements.
Creating elements in this collection is not supported.
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+ ←↩↪→ _event+'/message_template/',auth=auth,headers=headers).json())
⇒['connected to broker']
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/mqtt/notifications/events/:event/message_template/"
⇒["failed to connect to broker"]
Browse more samples
11.29.1.1 Message template element
sum (variant) mqtt/notifications/events/S/message_template/N/
Element of human-readable message template
DLI V222 Object Model Reference: 20210317T201932Z
662 CONTENTS
Message template elementStringParameter
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
check
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:
string String Fixed string
number Parameter Index of message parameter to insert event parameters[the value]
Sample uom library read command (note that _event and _message_template_element_index arevariables):
print(uom.dump(uom.mqtt.notifications.events[_event].message_template[ ←↩↪→ _message_template_element_index]))
⇒"failed to connect to broker"
Sample curl read command (note that :event and :message_template_element_index are URLtemplate arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/mqtt/notifications/events/:event/message_template/: ←↩↪→ message_template_element_index/"
⇒"connected to broker"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
11 MQTT client object 663
11.29.2 Severity
sum (enumerated number) mqtt/notifications/events/S/severity/
Severity rating assigned to the event
SeverityEmergencyAlertCriticalErrorWarningNoticeInformationalDebug
Administrative userAdministratorRegular user
can_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 1 Emergency Treat the event as an emergency
constant 2 Alert Treat the event as an alertconstant 3 Critical Treat the event as criticalconstant 4 Error Treat the event as an errorconstant 5 Warning Treat the event as a warning
constant 6 Notice Treat the event as a noticeconstant 7 Informational Treat the event as informationalconstant 8 Debug Treat the event as debugging-related
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+ ←↩↪→ _event+'/severity/',auth=auth,headers=headers).json())
DLI V222 Object Model Reference: 20210317T201932Z
664 CONTENTS
⇒6
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/mqtt/notifications/events/:event/severity/"
⇒6
Browse more samples
11.29.3 Event parameters
array mqtt/notifications/events/S/parameters/
Additional data associated with the event
Event parameterid:Identifierhas_fixed_value:Fixed value flagfixed_value:Fixed value
Event parameters[element]:Event parameter
0..*
check Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Event parameter elements.
Creating elements in this collection is not supported.
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+ ←↩↪→ _event+'/parameters/',auth=auth,headers=headers).json())
⇒
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 665
[{'fixed_value': False, 'has_fixed_value': True, 'id': 'connected'}]
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.mqtt.notifications.events[_event].parameters))
⇒{{fixed_value=true,has_fixed_value=true,id="connected"}}
Browse more samples
See also Event parameters: Event parameter
12 Meter server object
object meter/
Object representing the meter server state and configuration
Measured values[element]:Measured value
check
Bus list[element]:Bus attributes
Notificationsparameter_kinds:Parameter kindsevents:Events
Administrative userAdministratorRegular user
can_read
Meter server objectvalues:Measured valuesbuses:Bus listpower_status:Power statusemergency_off_status:Emergency shutoff status
synchronize () -> ( Empty result )
notifications:Notifications
This object contains the following items:
values Measured valuesbuses Bus listpower_status Power status
emergency_off_status Emergency shutoff status
synchronize Synchronize meter data
notifications Notifications
Sample JS request write command:
request.put({url:"meter/",body:<...>});
Sample CLI write command:
uom set meter ...
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
666 CONTENTS
12.1 Measured values
map meter/values/
Values measured by meters
Measured valuename:Value namevalue:Value, if anyexpression:Expression, if anycustom:Custom flagin_calibration:Calibration flagsupports_calibration:Calibration support flaginsert_calibration_point:Insert calibration pointcommit_calibration:Commit calibrationquantity:Quantitybus:Bus index, if anyinternal:Internallog_history:Log historyhistory_parameters:History log parametershistory_subsample_count:History subsample counthistory_time_step:History time stepget_history:Get value historyclear_history:Clear value historydata_absence_alarm_level:Data absence alarm level, if anydata_absence_alarm_period:Data absence alarm period, if anylowest_interval_alarm_level:Lowest interval alarm level, if anylowest_interval_alarm_period:Lowest interval alarm period, if anyintervals:Value interval properties
Custom flagCustomBuilt-in
can_deleteMeasured values
[element]:Measured value 0..*
check
This map contains Measured value elements.
Sample JS request write command:
request.put({url:"meter/values/",body:<...>});
Sample uom library measured value creation command:
uom.insert(uom.meter.values,"vcc_voltage",{bus=null,data_absence_alarm_level=1, ←↩↪→ data_absence_alarm_period=null,expression=null,history_parameters ←↩↪→ ={{300,86400},{3600,1209600},{86400,31536000}},history_subsample_count=1, ←↩↪→ history_time_step=6,in_calibration=false,internal=true,intervals={{ ←↩↪→ alarm_level=null,alarm_period=1,lower_bound_bottom=245,lower_bound_top ←↩↪→ =250.83333333333},{alarm_level=null,alarm_period=null,lower_bound_bottom ←↩↪→ =279.16666666667,lower_bound_top=285},{alarm_level=1,alarm_period=2, ←↩↪→ lower_bound_bottom=303.33333333333,lower_bound_top=310.83333333333},{ ←↩↪→ alarm_level=2,alarm_period=2,lower_bound_bottom=349.16666666667, ←↩↪→ lower_bound_top=354.16666666667}},log_history=false, ←↩↪→ lowest_interval_alarm_level=3,lowest_interval_alarm_period=1,name="DC ←↩↪→ voltage",quantity="voltage"})
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 667
12.1.1 Measured value
object meter/values/S/
Value measured by meter
History log parameters[element]:History log
Administrative userAdministratorRegular user
can_read,can_write
Value interval properties[element]:Interval configuration
can_read,can_write
Measured valuename:Value namevalue:Value, if anyexpression:Expression, if anycustom:Custom flagin_calibration:Calibration flagsupports_calibration:Calibration support flag
insert_calibration_point ( Kind Value Weight Derivative Derivative weight ) -> ( Empty result )
commit_calibration () -> ( Empty result )
quantity:Quantitybus:Bus index, if anyinternal:Internallog_history:Log historyhistory_parameters:History log parametershistory_subsample_count:History subsample counthistory_time_step:History time step
get_history ( Data start time Data end time Data time step ) -> ( Value history record )
clear_history () -> ( Empty result )
data_absence_alarm_level:Data absence alarm level, if anydata_absence_alarm_period:Data absence alarm period, if anylowest_interval_alarm_level:Lowest interval alarm level, if anylowest_interval_alarm_period:Lowest interval alarm period, if anyintervals:Value interval properties
descref__meter__values____customcan_delete
The value is subject to the following constraints: not index of the value matches ∧(|.∗|.∗)$
Removing the object from its parent collection is denied if not custom flag
This object contains the following items:
name Value namevalue Value, if any
expression Expression, if any
custom Custom flag
in_calibration Calibration flag
supports_calibration Calibration support flag
insert_calibration_point Insert calibration point
commit_calibration Commit calibrationquantity Quantity
bus Bus index, if any
internal Internallog_history Log history
history_parameters History log parameters
history_subsample_count History subsample count
history_time_step History time step
get_history Get value history
clear_history Clear value history
data_absence_alarm_level Data absence alarm level, if any
data_absence_alarm_period Data absence alarm period, if any
lowest_interval_alarm_level Lowest interval alarm level, if any
lowest_interval_alarm_period Lowest interval alarm period, if any
intervals Value interval properties
DLI V222 Object Model Reference: 20210317T201932Z
668 CONTENTS
Sample uom library read command (note that _measured_value is a variable):
print(uom.dump(uom.meter.values[_measured_value]))
⇒
Sample JS request read command (note that _measured_value is a variable):
request.get({url:"meter/values/"+_measured_value+"/"},function(error,response, ←↩↪→ body) {console.log(body)});
⇒
Browse more samples
See also Measured value: Value name
See also Measured value: Value, if any
See also Measured value: Expression, if any
See also Measured value: Custom flag
See also Measured value: Calibration flag
See also Measured value: Calibration support flag
See also Measured value: Insert calibration point
See also Measured value: Commit calibration
See also Measured value: Quantity
See also Measured value: Bus index, if any
See also Measured value: Internal
See also Measured value: Log history
See also Measured value: History log parameters
See also Measured value: History subsample count
See also Measured value: History time step
See also Measured value: Get value history
See also Measured value: Clear value history
See also Measured value: Data absence alarm level, if any
See also Measured value: Data absence alarm period, if any
See also Measured value: Lowest interval alarm level, if any
See also Measured value: Lowest interval alarm period, if any
See also Measured value: Value interval properties
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 669
12.2 Measured value: Value name
string meter/values/S/name/
Name of the measured value
Value name
Administrative userAdministratorRegular user
can_write
Custom flagCustomBuilt-in
readonly
Changing the value is denied if not administrative user
This string does not support direct modification if not custom flag.
This string represents a value in persistent storage.
Sample curl read command (note that :measured_value is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/values/:measured_value/name/"
⇒"AC voltage"
Sample requests write command (note that _measured_value is a variable):
requests.put('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/name ←↩↪→ /',auth=auth,headers=headers,json='DC voltage')
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
670 CONTENTS
12.3 Measured value: Value, if any
sum (variant) meter/values/S/value/
Current value measured by meter, if any
Value, if anyValueNo value
Administrative userAdministratorRegular user
can_write
Quantityquantity
Custom flagCustomBuilt-in
readonly
Agent identifier
readonly
Changing the value is denied if not administrative user
This sum does not support direct modification if all of the following is true:
• not custom flag
• agent identifier is not equal to relay
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum may have an effect besides setting value.
This sum can assume the following values:
number Value Current value measured by meter
constant false No value Indication that measurement is currently not being car-ried out
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 671
Sample JS request write command (note that _measured_value is a variable):
request.put({url:"meter/values/"+_measured_value+"/value/",body:116});
Sample CLI read command (note that measured_value is a variable):
uom get "meter/values/${measured_value}/value"
⇒1
Browse more samples
12.4 Measured value: Expression, if any
sum (optional string) meter/values/S/expression/
Expression governing the value, if any
Expression, if anyVariableExpression
Administrative userAdministratorRegular user
can_read,can_write
Custom flagCustomBuilt-in
readonly
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum does not support direct modification if not custom flag.
This sum represents a value in persistent storage.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant null Variable The value can be modified arbitrarily
string Expression Expression governing the value
DLI V222 Object Model Reference: 20210317T201932Z
672 CONTENTS
Sample CLI read command (note that measured_value is a variable):
uom get "meter/values/${measured_value}/expression"
⇒null
Sample uom library read command (note that _measured_value is a variable):
print(uom.dump(uom.meter.values[_measured_value].expression))
⇒"6.4"
Browse more samples
12.5 Measured value: Custom flag
sum (boolean) meter/values/S/custom/
Flag indicating whether the value is custom
Custom flagCustomBuilt-in
readonly,can_delete
Administrative userAdministratorRegular user
can_read
The value is unconditionally set to true on creation and doesn't have to be supplied (if it is, it must match)
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Custom The value is custom and can be modified freely
constant false Built-in The value is built-in and only the hardware can modifyit
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 673
Sample uom library read command (note that _measured_value is a variable):
print(uom.dump(uom.meter.values[_measured_value].custom))
⇒{}
Sample curl read command (note that :measured_value is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/values/:measured_value/custom/"
⇒[]
Browse more samples
12.6 Measured value: Calibration flag
sum (boolean) meter/values/S/in_calibration/
Flag indicating whether the value is being calibrated
Calibration flagCalibrationMeasurement
Calibration support flagSupportedNot supported
check,readonly,mutable
Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: any of the following is true:
• calibration support flag
• not the value
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum does not support direct modification if not calibration support flag.
This sum can change as if by itself or indirectly because of other actions if calibration support flag.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
674 CONTENTS
constant true Calibration The value is being calibrated (it can be updated tomatch external reference)
constant false Measurement The value is being measured
Sample JS request read command (note that _measured_value is a variable):
request.get({url:"meter/values/"+_measured_value+"/in_calibration/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒false
Sample requests read command (note that _measured_value is a variable):
print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value ←↩↪→ +'/in_calibration/',auth=auth,headers=headers).json())
⇒False
Browse more samples
12.7 Measured value: Calibration support flag
sum (boolean) meter/values/S/supports_calibration/
Flag indicating whether calibrating the value is supported
Calibration support flagSupportedNot supported
check,readonly,mutable
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum represents a value in persistent storage.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 675
constant true Supported The value can be calibrated
constant false Not supported There is no support for calibrating the value, or it doesnot make sense to
Sample JS request read command (note that _measured_value is a variable):
request.get({url:"meter/values/"+_measured_value+"/supports_calibration/"}, ←↩↪→ function(error,response,body) {console.log(body)});
⇒true
Sample uom library read command (note that _measured_value is a variable):
print(uom.dump(uom.meter.values[_measured_value].supports_calibration))
⇒false
Browse more samples
12.8 Measured value: Insert calibration point
call meter/values/S/insert_calibration_point/
Specify custom calibration point, possibly overriding measurements
Insert calibration point Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if any of the following is true:
• not administrative user
• not ../in_calibration
The call accepts the following arguments:
1. Kind: Standard, Identity or Current
DLI V222 Object Model Reference: 20210317T201932Z
676 CONTENTS
2. Value: number
3. Weight: number
4. Derivative: number
5. Derivative weight: number
The call returns the following results:
1. Empty result: null
Sample requests invocation (note that _measured_value is a variable):
requests.post('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/ ←↩↪→ insert_calibration_point/',auth=auth,headers=headers,json=['standard', 115, ←↩↪→ 1.2, -0.6, 6.1])
⇒(no output)
Sample curl invocation (note that :measured_value 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 "[\"current\",284,8.2,-0.8,3]" " ←↩↪→ http://192.168.0.100/restapi/meter/values/:measured_value/ ←↩↪→ insert_calibration_point/"
⇒null
Browse more samples
12.8.1 Kind
sum (enumerated string) meter/values/S/insert_calibration_point/arguments: 1/
Kind of calibration point
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant "standard" Standard The point supplies the calibrated value
constant "identity" Identity Assume the calibration function is the identity in point
constant "current" Current Assume the calibration function keeps current value inpoint
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 677
12.8.2 Value
number meter/values/S/insert_calibration_point/arguments: 2/
Calibrated value
Value Quantityquantity
The value represents quantity.
This number does not correspond to an actual resource.
12.8.3 Weight
number meter/values/S/insert_calibration_point/arguments: 3/
Weight of the calibration point
The value represents ratio, which is dimensionless.
To convert to percents, multiply by 100.
To convert from percents, divide by 100.
The value is subject to the following constraints: the value is greater or equal to 0
This number does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
678 CONTENTS
12.8.4 Derivative
number meter/values/S/insert_calibration_point/arguments: 4/
Derivative value in the calibration point
The value represents ratio, which is dimensionless.
To convert to percents, multiply by 100.
To convert from percents, divide by 100.
This number does not correspond to an actual resource.
12.8.5 Derivative weight
number meter/values/S/insert_calibration_point/arguments: 5/
Weight of derivative value in the calibration point
The value represents ratio, which is dimensionless.
To convert to percents, multiply by 100.
To convert from percents, divide by 100.
The value is subject to the following constraints: the value is greater or equal to 0
This number does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 679
12.8.6 Empty result
constant null meter/values/S/insert_calibration_point/results: 1/
No additional information available
This constant does not correspond to an actual resource.
12.9 Measured value: Commit calibration
call meter/values/S/commit_calibration/Save calibration data to persistent storage
Commit calibration Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if any of the following is true:
• not administrative user
• not ../in_calibration
The call has no arguments (supply empty tuple).
The call returns the following results:
1. Empty result: null
Sample CLI invocation (note that measured_value is a variable):
uom invoke "meter/values/${measured_value}/commit_calibration"
⇒(no output)
Sample JS request invocation (note that _measured_value is a variable):
request.post({url:"meter/values/"+_measured_value+"/commit_calibration/",body ←↩↪→ :[]});
⇒(no output)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
680 CONTENTS
12.9.1 Empty result
constant null meter/values/S/commit_calibration/results: 1/No additional information available
This constant does not correspond to an actual resource.
12.10 Measured value: Quantity
string meter/values/S/quantity/
Quantity of the value
Quantity
quantity
Administrative userAdministratorRegular user
can_write
Known quantities[element]:Quantity
check
Custom flagCustomBuilt-in
readonly
The value is subject to the following constraints: known quantities[the value]
Changing the value is denied if not administrative user
This string does not support direct modification if not custom flag.
This string represents a value in persistent storage.
Sample CLI read command (note that measured_value is a variable):
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 681
uom get "meter/values/${measured_value}/quantity"
⇒"current"
Sample JS request write command (note that _measured_value is a variable):
request.put({url:"meter/values/"+_measured_value+"/quantity/",body:"current"});
Browse more samples
12.11 Measured value: Bus index, if any
sum (optional number) meter/values/S/bus/
Index of bus being measured, if any
Bus index, if anyUnspecifiedBus index
Administrative userAdministratorRegular user
can_write
Custom flagCustomBuilt-in
readonly
Buses[element]:Bus
check
Changing the value is denied if not administrative user
This sum does not support direct modification if not custom flag.
This sum represents a value in persistent storage.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
682 CONTENTS
constant null Unspecified The value is not related to a bus
number Bus index Index of bus being measured buses[the value]
Sample JS request write command (note that _measured_value is a variable):
request.put({url:"meter/values/"+_measured_value+"/bus/",body:null});
Sample uom library read command (note that _measured_value is a variable):
print(uom.dump(uom.meter.values[_measured_value].bus))
⇒1
Browse more samples
12.12 Measured value: Internal
sum (boolean) meter/values/S/internal/
Flag indicating whether this value is internal
InternalInternalVisible
Administrative userAdministratorRegular user
can_write
Custom flagCustomBuilt-in
readonly
Changing the value is denied if not administrative user
This sum does not support direct modification if not custom flag.
This sum represents a value in persistent storage.
This sum can assume the following values:
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 683
constant true Internal The value is internal and should not matter to usersconstant false Visible The value should be visible to users
Sample requests read command (note that _measured_value is a variable):
print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value ←↩↪→ +'/internal/',auth=auth,headers=headers).json())
⇒True
Sample JS request write command (note that _measured_value is a variable):
request.put({url:"meter/values/"+_measured_value+"/internal/",body:false});
Browse more samples
12.13 Measured value: Log history
sum (boolean) meter/values/S/log_history/
Flag indicating whether the value should be logged to the history
Log historyEnabledDisabled
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true Enabled The feature is enabledconstant false Disabled The feature is disabled
Sample uom library write command (note that _measured_value is a variable):
uom.meter.values[_measured_value].log_history=true
DLI V222 Object Model Reference: 20210317T201932Z
684 CONTENTS
Sample curl read command (note that :measured_value is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/values/:measured_value/log_history/"
⇒true
Browse more samples
12.14 Measured value: History log parameters
array meter/values/S/history_parameters/
Configuration of history logs sampling intervals and timespans
History log0:Interval1:Span
History log parameters[element]:History log
0..*
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array can change as if by itself or indirectly because of other actions.
This array contains History log elements.
Sample curl write command (note that :measured_value 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 ←↩↪→ "[[300,86400],[3600,1209600],[86400,31536000]]" "http://192.168.0.100/ ←↩↪→ restapi/meter/values/:measured_value/history_parameters/"
Sample CLI history log creation command (note that measured_value is a variable):
uom insert "meter/values/${measured_value}/history_parameters/2" ←↩↪→ "[86400,31536000]"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 685
12.14.1 History log
tuple meter/values/S/history_parameters/N/
History log settings
This tuple is a part of a composite value which is modified as a whole.
This tuple contains the following items:
1 Interval2 Span
Sample curl read command (note that :measured_value and :history_log_index are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/values/:measured_value/history_parameters/:history_log_index ←↩↪→ /"
⇒[300,86400]
Sample curl write command (note that :measured_value and :history_log_index are URL templatearguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "[86400,31536000]" "http ←↩↪→ ://192.168.0.100/restapi/meter/values/:measured_value/history_parameters/: ←↩↪→ history_log_index/"
Browse more samples
12.14.1.1 Interval
number meter/values/S/history_parameters/N/1/
Time interval between two consecutive history samples (changes will trigger history rebuilding and may causeadjustments to time span)
DLI V222 Object Model Reference: 20210317T201932Z
686 CONTENTS
Interval
checkHistory time stepcheck
Administrative userAdministratorRegular user
can_read,can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: all of the following is true:
• the value is greater than 0
• the value to the power of history time step is equal to 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number represents a value in persistent storage.
This number can change as if by itself or indirectly because of other actions.
Sample curl write command (note that :measured_value and :history_log_index are URL templatearguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "86400" "http ←↩↪→ ://192.168.0.100/restapi/meter/values/:measured_value/history_parameters/: ←↩↪→ history_log_index/0/"
Sample JS request read command (note that _measured_value and _history_log_index arevariables):
request.get({url:"meter/values/"+_measured_value+"/history_parameters/"+ ←↩↪→ _history_log_index.toString()+"/0/"},function(error,response,body) {console ←↩↪→ .log(body)});
⇒86400
Browse more samples
12.14.1.2 Span
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 687
number meter/values/S/history_parameters/N/2/
Time span covered by history fragment (changes will trigger history rebuilding)
Span
Intervalcheck
Administrative userAdministratorRegular user
can_read,can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: all of the following is true:
• the value is greater than 0
• the value to the power of interval is equal to 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number represents a value in persistent storage.
This number can change as if by itself or indirectly because of other actions.
Sample uom library write command (note that _measured_value and _history_log_index arevariables):
uom.meter.values[_measured_value].history_parameters[_history_log_index ←↩↪→ ][2]=31536000
Sample uom library read command (note that _measured_value and _history_log_index arevariables):
print(uom.dump(uom.meter.values[_measured_value].history_parameters[ ←↩↪→ _history_log_index][2]))
⇒31536000
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
688 CONTENTS
12.15 Measured value: History subsample count
number meter/values/S/history_subsample_count/
Number of measurements per history sample
History subsample count Administrative userAdministratorRegular user
can_read,can_write
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample uom library read command (note that _measured_value is a variable):
print(uom.dump(uom.meter.values[_measured_value].history_subsample_count))
⇒2
Sample CLI read command (note that measured_value is a variable):
uom get "meter/values/${measured_value}/history_subsample_count"
⇒12
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 689
12.16 Measured value: History time step
number meter/values/S/history_time_step/
Minimal amount of time between saved history samples (changes will trigger history rebuilding and may causeadjustments to history_parameters)
History time step
check
Administrative userAdministratorRegular user
can_read,can_write
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample CLI read command (note that measured_value is a variable):
uom get "meter/values/${measured_value}/history_time_step"
⇒24
Sample JS request read command (note that _measured_value is a variable):
request.get({url:"meter/values/"+_measured_value+"/history_time_step/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒4
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
690 CONTENTS
12.17 Value history record: Value history
array meter/values/S/get_history/results: 1/3/
Historical data points
This array does not correspond to an actual resource.
This array contains Data point, if any elements.
12.17.1 Data point, if any
sum (variant) meter/values/S/get_history/results: 1/3/N/
Historical data point, if any
Data point, if anyData pointMissing data
Quantityquantity
This sum does not correspond to an actual resource.
This sum can assume the following values:
number Data point Historical data point, whose corresponding time is de-termined by array position
constant false Missing data Indication that data for the time determined by arrayposition could not be found
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 691
12.18 Measured value: Get value history
call meter/values/S/get_history/
Get history of values over a specific time range
Value history record0:Data start time1:Data time step2:Value historyGet value history
result
Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if not administrative user
The call accepts the following arguments:
1. Data start time: number
2. Data end time: number
3. Data time step: number
The call returns the following results:
1. Value history record: (number,number,array of "Data point or Missing data")
Sample CLI invocation (note that measured_value is a variable):
uom invoke "meter/values/${measured_value}/get_history" "1561792088" "1561792092" ←↩↪→ "1"
⇒[1561792088,1,[276,294,279,321]]
Sample JS request invocation (note that _measured_value is a variable):
request.post({url:"meter/values/"+_measured_value+"/get_history/",body ←↩↪→ :[1526768545,1526770345,300]});
⇒[1526768400,300,[3,false,false,false,9,4]]
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
692 CONTENTS
12.18.1 Data start time
number meter/values/S/get_history/arguments: 1/
Requested timestamp of the first data point to retrieve
The value represents time, the standard unit of which is the second (s).
This number does not correspond to an actual resource.
12.18.2 Data end time
number meter/values/S/get_history/arguments: 2/
Requested timestamp of the last data point to retrieve
The value represents time, the standard unit of which is the second (s).
This number does not correspond to an actual resource.
12.18.3 Data time step
number meter/values/S/get_history/arguments: 3/
Requested time step between succeeding data points
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater or equal to 0
This number does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 693
12.18.4 Value history record
tuple meter/values/S/get_history/results: 1/
Historical measured values
Value history[element]:Data point, if any
Value history record0:Data start time1:Data time step2:Value history
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 Data start time2 Data time step
3 Value history
12.18.4.1 Data start time
number meter/values/S/get_history/results: 1/1/
Timestamp of the first retrieved historical data point (may differ from requested start timestamp)
The value represents time, the standard unit of which is the second (s).
This number does not correspond to an actual resource.
12.18.4.2 Data time step
number meter/values/S/get_history/results: 1/2/
Time step between succeeding retrieved historical data points (may differ from requested time step)
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater or equal to 0
This number does not correspond to an actual resource.
See also Value history record: Value history
DLI V222 Object Model Reference: 20210317T201932Z
694 CONTENTS
12.19 Measured value: Clear value history
call meter/values/S/clear_history/
Clear the complete history of values, and reset value to zero
Clear value history Administrative userAdministratorRegular user
can_invoke
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. Empty result: null
Sample JS request invocation (note that _measured_value is a variable):
request.post({url:"meter/values/"+_measured_value+"/clear_history/",body:[]});
⇒(no output)
Sample requests invocation (note that _measured_value is a variable):
requests.post('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/ ←↩↪→ clear_history/',auth=auth,headers=headers,json={})
⇒(no output)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 695
12.19.1 Empty result
constant null meter/values/S/clear_history/results: 1/
No additional information available
This constant does not correspond to an actual resource.
12.20 Measured value: Data absence alarm level, if any
sum (optional number) meter/values/S/data_absence_alarm_level/
Alarm level for absence of data, if any
Data absence alarm level, if anyNoneData absence alarm level
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null None No alarm is generated on absence of data
number Data absence alarm level Alarm level for absence of data
Sample requests read command (note that _measured_value is a variable):
print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value ←↩↪→ +'/data_absence_alarm_level/',auth=auth,headers=headers).json())
⇒3
Sample CLI write command (note that measured_value is a variable):
uom set "meter/values/${measured_value}/data_absence_alarm_level" "null"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
696 CONTENTS
12.21 Measured value: Data absence alarm period, if any
sum (optional number) meter/values/S/data_absence_alarm_period/
The time interval after which data absence alarm events should be repeated, if any
Data absence alarm period, if anyNoneData absence alarm period
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null None The data absence alarm event is generated only onceon data loss and is not repeated
number Data absence alarm period The time interval after which dataabsence alarm events should be re-peated
the value is greater than 0
Sample requests read command (note that _measured_value is a variable):
print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value ←↩↪→ +'/data_absence_alarm_period/',auth=auth,headers=headers).json())
⇒None
Sample requests write command (note that _measured_value is a variable):
requests.put('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/ ←↩↪→ data_absence_alarm_period/',auth=auth,headers=headers,json=None)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 697
12.22 Measured value: Lowest interval alarm level, if any
sum (optional number) meter/values/S/lowest_interval_alarm_level/
Alarm level for the lowest value interval, if any
Lowest interval alarm level, if anyNoneLowest interval alarm level
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null None No alarm is generated for the lowest value interval
number Lowest interval alarm level Alarm level for the lowest value interval
Sample uom library read command (note that _measured_value is a variable):
print(uom.dump(uom.meter.values[_measured_value].lowest_interval_alarm_level))
⇒null
Sample JS request read command (note that _measured_value is a variable):
request.get({url:"meter/values/"+_measured_value+"/lowest_interval_alarm_level ←↩↪→ /"},function(error,response,body) {console.log(body)});
⇒null
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
698 CONTENTS
12.23 Measured value: Lowest interval alarm period, if any
sum (optional number) meter/values/S/lowest_interval_alarm_period/
The time interval after which lowest interval alarm events should be repeated, if any
Lowest interval alarm period, if anyNoneLowest interval alarm period
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null None The alarm event is generated only once at lowest inter-val entry and is not repeated while the value is in theinterval
number Lowest interval alarm period The time interval after which low-est interval alarm events should berepeated
the value is greater than 0
Sample curl read command (note that :measured_value is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/values/:measured_value/lowest_interval_alarm_period/"
⇒5
Sample JS request write command (note that _measured_value is a variable):
request.put({url:"meter/values/"+_measured_value+"/lowest_interval_alarm_period ←↩↪→ /",body:null});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 699
12.24 Measured value: Value interval properties
array meter/values/S/intervals/
Properties defining intervals of the value and their alarm levels
Interval configurationlower_bound_bottom:Lower bound bottomlower_bound_top:Lower bound topalarm_level:Alarm level, if anyalarm_period:Alarm period, if any
Value interval properties[element]:Interval configuration
0..*
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array contains Interval configuration elements.
Sample curl interval configuration creation command (note that :measured_value is a URL templateargument):
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H ←↩↪→ "Accept: application/json" --data-binary "{\"lower_bound_bottom ←↩↪→ \":57.833333333333,\"alarm_level\":null,\"lower_bound_top ←↩↪→ \":58.916666666667,\"alarm_period\":3}" "http://192.168.0.100/restapi/meter ←↩↪→ /values/:measured_value/intervals/"
Sample CLI read command (note that measured_value is a variable):
uom get "meter/values/${measured_value}/intervals"
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
700 CONTENTS
12.24.1 Interval configuration
object meter/values/S/intervals/N/
Configuration of a value interval
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
lower_bound_bottom Lower bound bottomlower_bound_top Lower bound top
alarm_level Alarm level, if any
alarm_period Alarm period, if any
Sample requests read command (note that _measured_value and _interval_configuration_←↩
index are variables):
print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value ←↩↪→ +'/intervals/'+str(_interval_configuration_index)+'/',auth=auth,headers= ←↩↪→ headers).json())
⇒{'lower_bound_bottom': 9.1591591591592, 'alarm_level': None, 'lower_bound_top': ←↩
↪→ 9.5795795795796, 'alarm_period': 3}
Sample JS request deletion command (note that _measured_value and _interval_configuration←↩
_index are variables):
request.delete({url:"meter/values/"+_measured_value+"/intervals/"+ ←↩↪→ _interval_configuration_index.toString()+"/"});
Browse more samples
12.24.1.1 Lower bound bottom
number meter/values/S/intervals/N/lower_bound_bottom/The bottom of the lower bound of this interval; value must be lower to be considered outside this interval
Lower bound bottom Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 701
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number represents a value in persistent storage.
Sample curl write command (note that :measured_value and :interval_configuration_indexare URL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/ ←↩↪→ json" -H "Accept: application/json" --data-binary "59" "http ←↩↪→ ://192.168.0.100/restapi/meter/values/:measured_value/intervals/: ←↩↪→ interval_configuration_index/lower_bound_bottom/"
Sample JS request read command (note that _measured_value and _interval_configuration_←↩
index are variables):
request.get({url:"meter/values/"+_measured_value+"/intervals/"+ ←↩↪→ _interval_configuration_index.toString()+"/lower_bound_bottom/"},function( ←↩↪→ error,response,body) {console.log(body)});
⇒2.7027027027027
Browse more samples
12.24.1.2 Lower bound top
number meter/values/S/intervals/N/lower_bound_top/
The top of the lower bound of this interval; value must be higher to be considered inside this interval
Lower bound top Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number represents a value in persistent storage.
Sample curl read command (note that :measured_value and :interval_configuration_indexare URL template arguments):
DLI V222 Object Model Reference: 20210317T201932Z
702 CONTENTS
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/values/:measured_value/intervals/: ←↩↪→ interval_configuration_index/lower_bound_top/"
⇒32.166666666667
Sample requests read command (note that _measured_value and _interval_configuration_←↩
index are variables):
print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value ←↩↪→ +'/intervals/'+str(_interval_configuration_index)+'/lower_bound_top/',auth= ←↩↪→ auth,headers=headers).json())
⇒402
Browse more samples
12.24.1.3 Alarm level, if any
sum (optional number) meter/values/S/intervals/N/alarm_level/
The level of importance assigned to this interval, if any
Alarm level, if anyNoneAlarm level
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None No alarm is generated for this value interval
number Alarm level The level of importance assigned to this interval
Sample CLI read command (note that measured_value and interval_configuration_index are
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 703
variables):
uom get "meter/values/${measured_value}/intervals/${interval_configuration_index ←↩↪→ }/alarm_level"
⇒null
Sample requests write command (note that _measured_value and _interval_configuration_←↩
index are variables):
requests.put('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/ ←↩↪→ intervals/'+str(_interval_configuration_index)+'/alarm_level/',auth=auth, ←↩↪→ headers=headers,json=4)
Browse more samples
12.24.1.4 Alarm period, if any
sum (optional number) meter/values/S/intervals/N/alarm_period/
The time interval after which alarm events should be repeated, if any
Alarm period, if anyNoneAlarm period
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing 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 represents a value in persistent storage.
This sum can assume the following values:
constant null None The alarm event is generated only once at interval en-try and is not repeated while the value is in the interval
number Alarm period The time interval after which alarm events shouldbe repeated
the value is greater than 0
Sample curl read command (note that :measured_value and :interval_configuration_indexare URL template arguments):
DLI V222 Object Model Reference: 20210317T201932Z
704 CONTENTS
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/values/:measured_value/intervals/: ←↩↪→ interval_configuration_index/alarm_period/"
⇒null
Sample requests read command (note that _measured_value and _interval_configuration_←↩
index are variables):
print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value ←↩↪→ +'/intervals/'+str(_interval_configuration_index)+'/alarm_period/',auth= ←↩↪→ auth,headers=headers).json())
⇒1
Browse more samples
12.25 Bus list
array meter/buses/
Attributes for buses
Bus attributesname:Namepower_status:Power statuspower_factor_percent:Power factor
Buses[element]:Bus
checkBus list
[element]:Bus attributes 0..*
This array does not support direct modification.
This array contains Bus attributes elements.
Creating elements in this collection is not supported.
Sample uom library read command:
print(uom.dump(uom.meter.buses))
⇒{{name="Bus A",power_factor_percent=100,power_status=true},{name="Bus B", ←↩
↪→ power_factor_percent=100,power_status=false}}
Sample requests read command:
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 705
print(requests.get('http://192.168.0.100/restapi/meter/buses/',auth=auth,headers= ←↩↪→ headers).json())
⇒[{'power_status': True, 'name': 'Bus A', 'power_factor_percent': 100}, {' ←↩
↪→ power_status': False, 'name': 'Bus B', 'power_factor_percent': 100}]
Browse more samples
See also Bus list: Bus attributes
12.26 Bus list: Bus attributes
object meter/buses/N/
Attributes for a bus
Bus attributesname:Namepower_status:Power statuspower_factor_percent:Power factor
Buses[element]:Bus
check
The value is subject to the following constraints: buses[index of the value]
This object contains the following items:
name Namepower_status Power status
power_factor_percent Power factor
Sample requests write command (note that _bus_attributes_index is a variable):
requests.put('http://192.168.0.100/restapi/meter/buses/'+str( ←↩↪→ _bus_attributes_index)+'/',auth=auth,headers=headers,json={'power_status': ←↩↪→ True, 'name': 'Bus A', 'power_factor_percent': 100})
Sample JS request write command (note that _bus_attributes_index is a variable):
request.put({url:"meter/buses/"+_bus_attributes_index.toString()+"/",body:{" ←↩↪→ power_status":true,"name":"Bus A","power_factor_percent":100}});
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
706 CONTENTS
12.26.1 Name
string meter/buses/N/name/
User-visible name of this bus
Name Administrative userAdministratorRegular user
can_write
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample requests read command (note that _bus_attributes_index is a variable):
print(requests.get('http://192.168.0.100/restapi/meter/buses/'+str( ←↩↪→ _bus_attributes_index)+'/name/',auth=auth,headers=headers).json())
⇒'Bus B'
Sample CLI read command (note that bus_attributes_index is a variable):
uom get "meter/buses/${bus_attributes_index}/name"
⇒"Bus A"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 707
12.26.2 Power status
sum (boolean) meter/buses/N/power_status/
Status of bus power
Power statusOnOff
Administrative userAdministratorRegular user
can_read,can_write
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant true On Bus is powered
constant false Off Bus is not powered
Sample CLI read command (note that bus_attributes_index is a variable):
uom get "meter/buses/${bus_attributes_index}/power_status"
⇒true
Sample requests read command (note that _bus_attributes_index is a variable):
print(requests.get('http://192.168.0.100/restapi/meter/buses/'+str( ←↩↪→ _bus_attributes_index)+'/power_status/',auth=auth,headers=headers).json())
⇒False
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
708 CONTENTS
12.26.3 Power factor
number meter/buses/N/power_factor_percent/
Power factor for this bus
Power factor Administrative userAdministratorRegular user
can_read,can_write
The value is subject to the following constraints: all of the following is true:
• the value is greater or equal to 0
• the value is less or equal to 100
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample JS request read command (note that _bus_attributes_index is a variable):
request.get({url:"meter/buses/"+_bus_attributes_index.toString()+"/ ←↩↪→ power_factor_percent/"},function(error,response,body) {console.log(body)});
⇒100
Sample uom library write command (note that _bus_attributes_index is a variable):
uom.meter.buses[_bus_attributes_index].power_factor_percent=100
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 709
12.27 Power status
sum (boolean) meter/power_status/
Status of unit power
Power statusMainsBattery
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant true Mains Unit is powered from at least one bus, outlets can bedriven
constant false Battery Unit is powered from the battery only, outlets cannotbe driven, unit shutdown expected
Sample uom library read command:
print(uom.dump(uom.meter.power_status))
⇒true
Sample CLI read command:
uom get "meter/power_status"
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
710 CONTENTS
12.28 Emergency shutoff status
sum (optional boolean) meter/emergency_off_status/
Status of emergency shutoff
Emergency shutoff statusActiveInactiveUnknown
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant true Active Emergency shutoff active, all outlets off
constant false Inactive Emergency shutoff inactive, normal outlet operation
constant null Unknown Emergency shutoff is in an unknown state, probablydue to power failure, all outlets likely off
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/emergency_off_status/"
⇒false
Sample CLI read command:
uom get "meter/emergency_off_status"
⇒false
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 711
12.29 Synchronize meter data
call meter/synchronize/
Saves meter data to persistent storage expressly (synchronization takes place periodically even without this call)
Synchronize meter data Administrative userAdministratorRegular user
can_invoke
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. Empty result: null
Sample curl invocation:
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/meter/synchronize/"
⇒null
Sample uom library invocation:
uom.meter.synchronize()
⇒(no output)
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
712 CONTENTS
12.29.1 Empty result
constant null meter/synchronize/results: 1/
No additional information available
This constant does not correspond to an actual resource.
12.30 Notifications
object meter/notifications/
Meter status notifications
Parameter kindsbus_index:Bus indexbus_name:Bus namebus_powered:Bus power statuspowered:Power statusemergency_off:Emergency shutoff statusvalue_id:Value identifiervalue_name:Value namevalue_alarm_level:Value alarm levelvalue_alarm_repeated:Value alarm repeat count, if anyvalue_alarm_duration:Value alarm duration
check
Events[element]:Event
Administrative userAdministratorRegular user
can_read
Notificationsparameter_kinds:Parameter kindsevents:Events
can_read
Retrieving the value is denied if not administrative user
This object does not support direct modification.
This object contains the following items:
parameter_kinds Parameter kinds
events Events
Sample CLI read command:
uom get "meter/notifications"
⇒...
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/notifications/"
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 713
⇒...
Browse more samples
See also Notifications: Parameter kinds
12.30.1 Events
map meter/notifications/events/
Event templates
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
Events[element]:Event
0..*
Administrative userAdministratorRegular user
can_read
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 Event elements.
Creating elements in this collection is not supported.
Sample JS request read command:
request.get({url:"meter/notifications/events/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒<...>
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/notifications/events/"
⇒...
Browse more samples
See also Events: Event
DLI V222 Object Model Reference: 20210317T201932Z
714 CONTENTS
12.31 Notifications: Parameter kinds
object meter/notifications/parameter_kinds/
Kinds of event parameters
This object does not correspond to an actual resource.
This object contains the following items:
bus_index Bus indexbus_name Bus namebus_powered Bus power status
powered Power status
emergency_off Emergency shutoff status
value_id Value identifiervalue_name Value namevalue_alarm_level Value alarm levelvalue_alarm_repeated Value alarm repeat count, if any
value_alarm_duration Value alarm duration
12.31.1 Bus index
number meter/notifications/parameter_kinds/bus_index/
Index of the bus
12.31.2 Bus name
number meter/notifications/parameter_kinds/bus_name/
Name of the bus
12.31.3 Bus power status
sum (boolean) meter/notifications/parameter_kinds/bus_powered/
Status of bus power
This sum can assume the following values:
constant true Powered The bus is powered
constant false Not powered The bus is not powered
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 715
12.31.4 Power status
sum (boolean) meter/notifications/parameter_kinds/powered/
Status of unit power
This sum can assume the following values:
constant true Mains The unit is running on mains
constant false Battery The unit is running on battery
12.31.5 Emergency shutoff status
sum (boolean) meter/notifications/parameter_kinds/emergency_off/
Status of emergency shutoff
This sum can assume the following values:
constant true Active All outlets offconstant false Inactive Normal outlet operation
12.31.6 Value identifier
string meter/notifications/parameter_kinds/value_id/
Identifier of the value
12.31.7 Value name
string meter/notifications/parameter_kinds/value_name/
Name of the value
12.31.8 Value alarm level
number meter/notifications/parameter_kinds/value_alarm_level/
Alarm level associated with the value
12.31.9 Value alarm repeat count, if any
sum (optional number) meter/notifications/parameter_kinds/value_alarm_repeated/
Number of consecutive times this alarm has been sent, if any
This sum can assume the following values:
constant null Initial alarm The value has just entered the interval
DLI V222 Object Model Reference: 20210317T201932Z
716 CONTENTS
number Value alarm repeat count Number of consecutive timesthis alarm has been sent
all of the following is true:
• the value is an integer
• the value is greater orequal to 0
12.31.10 Value alarm duration
number meter/notifications/parameter_kinds/value_alarm_duration/
Amount of time the value has been at this alarm level
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater or equal to 0
12.32 Event parameters: Event parameter
object meter/notifications/events/S/parameters/N/
Properties of a parameter associated with the event
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
id Identifierhas_fixed_value Fixed value flag
fixed_value Fixed value
Sample JS request read command (note that _event and _event_parameter_index are variables):
request.get({url:"meter/notifications/events/"+_event+"/parameters/"+ ←↩↪→ _event_parameter_index.toString()+"/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒{"fixed_value":null,"has_fixed_value":false,"id":"value_id"}
Sample CLI write command (note that event and event_parameter_index are variables):
uom set "meter/notifications/events/${event}/parameters/${event_parameter_index}" ←↩↪→ "{\"fixed_value\":null,\"has_fixed_value\":false,\"id\":\" ←↩↪→ value_alarm_duration\"}"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 717
12.32.1 Identifier
string meter/notifications/events/S/parameters/N/id/
Parameter identifier
Identifier
Parameter kindsbus_index:Bus indexbus_name:Bus namebus_powered:Bus power statuspowered:Power statusemergency_off:Emergency shutoff statusvalue_id:Value identifiervalue_name:Value namevalue_alarm_level:Value alarm levelvalue_alarm_repeated:Value alarm repeat count, if anyvalue_alarm_duration:Value alarm duration
check
Administrative userAdministratorRegular user
can_read
The value is subject to the following constraints: parameter kinds[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 _event and _event_parameter_index are variables):
request.get({url:"meter/notifications/events/"+_event+"/parameters/"+ ←↩↪→ _event_parameter_index.toString()+"/id/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒"value_id"
Sample curl read command (note that :event and :event_parameter_index are URL templatearguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/notifications/events/:event/parameters/:event_parameter_index ←↩↪→ /id/"
⇒"bus_powered"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
718 CONTENTS
12.32.2 Fixed value flag
sum (boolean) meter/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
Fixed value flagFixedVariable
Administrative userAdministratorRegular user
can_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 Fixed The value is fixedconstant false Variable The value is variable
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.meter.notifications.events[_event].parameters[ ←↩↪→ _event_parameter_index].has_fixed_value))
⇒true
Sample CLI read command (note that event and event_parameter_index are variables):
uom get "meter/notifications/events/${event}/parameters/${event_parameter_index}/ ←↩↪→ has_fixed_value"
⇒true
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 719
12.32.3 Fixed value
sum (variant) meter/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
Fixed valueNullTrueFalseStringNumber
Administrative userAdministratorRegular user
can_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 null Null Nullconstant true True Trueconstant false False Falsestring String This string
number Number This number
Sample CLI read command (note that event and event_parameter_index are variables):
uom get "meter/notifications/events/${event}/parameters/${event_parameter_index}/ ←↩↪→ fixed_value"
⇒
null
Sample curl read command (note that :event and :event_parameter_index are URL templatearguments):
DLI V222 Object Model Reference: 20210317T201932Z
720 CONTENTS
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/notifications/events/:event/parameters/:event_parameter_index ←↩↪→ /fixed_value/"
⇒false
Browse more samples
12.33 Events: Event
object meter/notifications/events/S/
Event template
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
can_readcheck
Eventmessage_template:Message templateseverity:Severityparameters:Event parameters
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
message_template Message template
severity Severity
parameters Event parameters
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.meter.notifications.events[_event]))
⇒{message_template={"bus ",0," (",1,") is powered"},parameters={{fixed_value=null, ←↩
↪→ has_fixed_value=false,id="bus_index"},{fixed_value=null,has_fixed_value= ←↩↪→ false,id="bus_name"},{fixed_value=true,has_fixed_value=true,id="bus_powered ←↩↪→ "}},severity=6}
Sample curl write command (note that :event 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 "{\"severity\":7,\" ←↩↪→ message_template\":[0,\" is at alarm level \",1,\" for \",2,\" seconds ←↩↪→ \"],\"parameters\":[{\"fixed_value\":null,\"has_fixed_value\":false,\"id ←↩↪→ \":\"value_name\"},{\"fixed_value\":null,\"has_fixed_value\":false,\"id ←↩
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 721
↪→ \":\"value_alarm_level\"},{\"fixed_value\":null,\"has_fixed_value\":false ←↩↪→ ,\"id\":\"value_alarm_duration\"},{\"fixed_value\":null,\"has_fixed_value ←↩↪→ \":false,\"id\":\"value_id\"},{\"fixed_value\":null,\"has_fixed_value\": ←↩↪→ false,\"id\":\"value_alarm_repeated\"}]}" "http://192.168.0.100/restapi/ ←↩↪→ meter/notifications/events/:event/"
Browse more samples
12.33.1 Message template
array meter/notifications/events/S/message_template/
Template for human-readable message generation
Message template[element]:Message template element
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Message template element elements.
Creating elements in this collection is not supported.
Sample curl read command (note that :event is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/meter/notifications/events/:event/message_template/"
⇒["emergency shutoff activated, all outlets off"]
Sample CLI read command (note that event is a variable):
uom get "meter/notifications/events/${event}/message_template"
⇒["bus ",0," (",1,") is powered"]
Browse more samples
12.33.1.1 Message template element
DLI V222 Object Model Reference: 20210317T201932Z
722 CONTENTS
sum (variant) meter/notifications/events/S/message_template/N/
Element of human-readable message template
Message template elementStringParameter
Administrative userAdministratorRegular user
can_read
Event parameters[element]:Event parameter
check
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:
string String Fixed string
number Parameter Index of message parameter to insert event parameters[the value]
Sample CLI read command (note that event and message_template_element_index are variables):
uom get "meter/notifications/events/${event}/message_template/${ ←↩↪→ message_template_element_index}"
⇒1
Sample uom library read command (note that _event and _message_template_element_index arevariables):
print(uom.dump(uom.meter.notifications.events[_event].message_template[ ←↩↪→ _message_template_element_index]))
⇒0
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
12 Meter server object 723
12.33.2 Severity
sum (enumerated number) meter/notifications/events/S/severity/
Severity rating assigned to the event
SeverityEmergencyAlertCriticalErrorWarningNoticeInformationalDebug
Administrative userAdministratorRegular user
can_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 1 Emergency Treat the event as an emergency
constant 2 Alert Treat the event as an alertconstant 3 Critical Treat the event as criticalconstant 4 Error Treat the event as an errorconstant 5 Warning Treat the event as a warning
constant 6 Notice Treat the event as a noticeconstant 7 Informational Treat the event as informationalconstant 8 Debug Treat the event as debugging-related
Sample JS request read command (note that _event is a variable):
request.get({url:"meter/notifications/events/"+_event+"/severity/"},function( ←↩↪→ error,response,body) {console.log(body)});
DLI V222 Object Model Reference: 20210317T201932Z
724 CONTENTS
⇒5
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/meter/notifications/events/'+ ←↩↪→ _event+'/severity/',auth=auth,headers=headers).json())
⇒5
Browse more samples
12.33.3 Event parameters
array meter/notifications/events/S/parameters/
Additional data associated with the event
Event parameterid:Identifierhas_fixed_value:Fixed value flagfixed_value:Fixed value
Event parameters[element]:Event parameter
0..*
check Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Event parameter elements.
Creating elements in this collection is not supported.
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/meter/notifications/events/'+ ←↩↪→ _event+'/parameters/',auth=auth,headers=headers).json())
⇒
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 725
Sample CLI read command (note that event is a variable):
uom get "meter/notifications/events/${event}/parameters"
⇒[{"fixed_value":true,"has_fixed_value":true,"id":"powered"}]
Browse more samples
See also Event parameters: Event parameter
13 Renderer object
object renderer/
Object representing renderer capabilities and functions
Plot styles[element]:Name
check
Administrative userAdministratorRegular user
can_read
Plot scales[element]:Name can_read
check
Line types[element]:Name
can_read
check
Marker types[element]:Name
can_read
check
Axes[element]:Name
can_read
check
Image formats[element]:Name
can_read
check
Renderer object
draw_plot ( Format Width Height Properties Lines ) -> ( Content type Image data )
draw_pie_meter ( Format Width Height Properties Value Value quantity and unit ) -> ( Content type Image data )
draw_message ( Format Width Height Message ) -> ( Content type Image data )
known_plot_styles:Plot stylesknown_scales:Plot scalesknown_line_types:Line typesknown_marker_types:Marker typesknown_axes:Axesknown_image_formats:Image formats
can_read
Retrieving the value is denied if not administrative user
This object contains the following items:
draw_plot Draw a plot
draw_pie_meter Draw a pie meter
draw_message Draw a message
known_plot_styles Plot styles
known_scales Plot scalesknown_line_types Line types
known_marker_types Marker types
known_axes Axesknown_image_formats Image formats
DLI V222 Object Model Reference: 20210317T201932Z
726 CONTENTS
Sample uom library read command:
print(uom.dump(uom.renderer))
⇒
Sample CLI read command:
uom get renderer
⇒
Browse more samples
13.1 Draw a plot
call renderer/draw_plot/
Generate an image with axes and data plotted on them
Propertiestime_format:Custom time format, if anyx1:X1 axis settingsx2:X2 axis settingsy1:Y1 axis settingsy2:Y2 axis settings
Lines[element]:Line
Draw a plot
argument
argument
Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if not administrative user
The call accepts the following arguments:
1. Format: string
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 727
2. Width: number
3. Height: number
4. Properties: object "Properties"
5. Lines: array of "(string,array of "(number,None or Y)",object "Style",(object "X axis quantity and unit",object"Y axis quantity and unit"))"
The call returns the following results:
1. Content type: string
2. Image data: string
Sample JS request invocation:
request.post({url:"renderer/draw_plot/",body:<...>});
⇒"<binary data of type image/png>"
Sample requests invocation:
print(requests.post('http://192.168.0.100/restapi/renderer/draw_plot/',auth=auth, ←↩↪→ headers=headers,json=<...>).json())
⇒'<binary data of type image/svg+xml>'
Browse more samples
13.1.1 Format
string renderer/draw_plot/arguments: 1/
Image format
DLI V222 Object Model Reference: 20210317T201932Z
728 CONTENTS
Format Image formats[element]:Name
check
The value is subject to the following constraints: image formats[the value]
This string does not correspond to an actual resource.
13.1.2 Width
number renderer/draw_plot/arguments: 2/
The width of the image
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
This number does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 729
13.1.3 Height
number renderer/draw_plot/arguments: 3/
The height of the image
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
This number does not correspond to an actual resource.
13.1.4 Properties
object renderer/draw_plot/arguments: 4/
Properties of the plot
X1 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
X2 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
Y1 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
Y2 axis settingsmin:Minimum, if anymax:Maximum, if anysoftmin:Soft minimum, if anysoftmax:Soft maximum, if anytics:Major tick interval, if anymtics:Minor ticks per major tick, if any
Propertiestime_format:Custom time format, if anyx1:X1 axis settingsx2:X2 axis settingsy1:Y1 axis settingsy2:Y2 axis settings
This object does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
730 CONTENTS
This object contains the following items:
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 731
time_format Custom time format, if any
x1 X1 axis settings
x2 X2 axis settings
y1 Y1 axis settings
y2 Y2 axis settings
See also Properties: Custom time format, if any
See also Properties: X1 axis settings
See also Properties: X2 axis settings
See also Properties: Y1 axis settings
See also Properties: Y2 axis settings
13.1.5 Lines
array renderer/draw_plot/arguments: 5/
Plot data lines
Line0:Title1:Plot data2:Style3:Plotted quantities and units
Lines[element]:Line 0..*
This array does not correspond to an actual resource.
This array contains Line elements.
See also Lines: Line
DLI V222 Object Model Reference: 20210317T201932Z
732 CONTENTS
13.1.6 Content type
string renderer/draw_plot/results: 1/
The content type of the generated image
This string does not correspond to an actual resource.
13.1.7 Image data
string renderer/draw_plot/results: 2/
Generated image data
Image data Content typecontent
The value contains content type data.
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 733
13.2 Properties: Custom time format, if any
sum (optional string) renderer/draw_plot/arguments: 4/time_format/
Custom format to display time in, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Default Use default time formatstring Custom time format Custom format to display time in
13.3 Properties: X1 axis settings
object renderer/draw_plot/arguments: 4/x1/
Configuration for X1 axis
This object does not correspond to an actual resource.
This object contains the following items:
min Minimum, if any
max Maximum, if any
softmin Soft minimum, if any
softmax Soft maximum, if any
tics Major tick interval, if any
mtics Minor ticks per major tick, if any
DLI V222 Object Model Reference: 20210317T201932Z
734 CONTENTS
13.3.1 Minimum, if any
sum (optional number) renderer/draw_plot/arguments: 4/x1/min/
Minimum value to display on the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The maximum value is derived from data and the softmaximum
number Minimum Minimum value to display on the axis
13.3.2 Maximum, if any
sum (optional number) renderer/draw_plot/arguments: 4/x1/max/
Maximum value to display on the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The minimum value is derived from data and the softminimum
number Maximum Maximum value to display on the axis
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 735
13.3.3 Soft minimum, if any
sum (optional number) renderer/draw_plot/arguments: 4/x1/softmin/
Minimum value to display on the axis unless values exist below it, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None No soft maximum definednumber Soft minimum Minimum value to display on the axis unless values
exist below it
13.3.4 Soft maximum, if any
sum (optional number) renderer/draw_plot/arguments: 4/x1/softmax/
Maximum value to display on the axis unless values exist above it, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None No soft minimum definednumber Soft maximum Maximum value to display on the axis unless values
exist above it
DLI V222 Object Model Reference: 20210317T201932Z
736 CONTENTS
13.3.5 Major tick interval, if any
sum (optional number) renderer/draw_plot/arguments: 4/x1/tics/
The interval, in value units, between major ticks of the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The tick interval is derived from data and sizenumber Major tick interval The interval, in value units, between major ticks of the
axis
13.3.6 Minor ticks per major tick, if any
sum (optional number) renderer/draw_plot/arguments: 4/x1/mtics/
The number of minor ticks between two major ticks, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None There are no minor ticksnumber Minor ticks per major tick The number of minor ticks be-
tween two major ticksall of the following is true:
• the value is an integer
• the value is greater orequal to 0
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 737
13.4 Properties: X2 axis settings
object renderer/draw_plot/arguments: 4/x2/
Configuration for X2 axis
This object does not correspond to an actual resource.
This object contains the following items:
min Minimum, if any
max Maximum, if any
softmin Soft minimum, if any
softmax Soft maximum, if any
tics Major tick interval, if any
mtics Minor ticks per major tick, if any
13.4.1 Minimum, if any
sum (optional number) renderer/draw_plot/arguments: 4/x2/min/
Minimum value to display on the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The maximum value is derived from data and the softmaximum
number Minimum Minimum value to display on the axis
DLI V222 Object Model Reference: 20210317T201932Z
738 CONTENTS
13.4.2 Maximum, if any
sum (optional number) renderer/draw_plot/arguments: 4/x2/max/
Maximum value to display on the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The minimum value is derived from data and the softminimum
number Maximum Maximum value to display on the axis
13.4.3 Soft minimum, if any
sum (optional number) renderer/draw_plot/arguments: 4/x2/softmin/
Minimum value to display on the axis unless values exist below it, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None No soft maximum definednumber Soft minimum Minimum value to display on the axis unless values
exist below it
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 739
13.4.4 Soft maximum, if any
sum (optional number) renderer/draw_plot/arguments: 4/x2/softmax/
Maximum value to display on the axis unless values exist above it, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None No soft minimum definednumber Soft maximum Maximum value to display on the axis unless values
exist above it
13.4.5 Major tick interval, if any
sum (optional number) renderer/draw_plot/arguments: 4/x2/tics/
The interval, in value units, between major ticks of the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The tick interval is derived from data and sizenumber Major tick interval The interval, in value units, between major ticks of the
axis
DLI V222 Object Model Reference: 20210317T201932Z
740 CONTENTS
13.4.6 Minor ticks per major tick, if any
sum (optional number) renderer/draw_plot/arguments: 4/x2/mtics/
The number of minor ticks between two major ticks, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None There are no minor ticksnumber Minor ticks per major tick The number of minor ticks be-
tween two major ticksall of the following is true:
• the value is an integer
• the value is greater orequal to 0
13.5 Properties: Y1 axis settings
object renderer/draw_plot/arguments: 4/y1/
Configuration for Y1 axis
This object does not correspond to an actual resource.
This object contains the following items:
min Minimum, if any
max Maximum, if any
softmin Soft minimum, if any
softmax Soft maximum, if any
tics Major tick interval, if any
mtics Minor ticks per major tick, if any
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 741
13.5.1 Minimum, if any
sum (optional number) renderer/draw_plot/arguments: 4/y1/min/
Minimum value to display on the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The maximum value is derived from data and the softmaximum
number Minimum Minimum value to display on the axis
13.5.2 Maximum, if any
sum (optional number) renderer/draw_plot/arguments: 4/y1/max/
Maximum value to display on the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The minimum value is derived from data and the softminimum
number Maximum Maximum value to display on the axis
DLI V222 Object Model Reference: 20210317T201932Z
742 CONTENTS
13.5.3 Soft minimum, if any
sum (optional number) renderer/draw_plot/arguments: 4/y1/softmin/
Minimum value to display on the axis unless values exist below it, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None No soft maximum definednumber Soft minimum Minimum value to display on the axis unless values
exist below it
13.5.4 Soft maximum, if any
sum (optional number) renderer/draw_plot/arguments: 4/y1/softmax/
Maximum value to display on the axis unless values exist above it, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None No soft minimum definednumber Soft maximum Maximum value to display on the axis unless values
exist above it
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 743
13.5.5 Major tick interval, if any
sum (optional number) renderer/draw_plot/arguments: 4/y1/tics/
The interval, in value units, between major ticks of the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The tick interval is derived from data and sizenumber Major tick interval The interval, in value units, between major ticks of the
axis
13.5.6 Minor ticks per major tick, if any
sum (optional number) renderer/draw_plot/arguments: 4/y1/mtics/
The number of minor ticks between two major ticks, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None There are no minor ticksnumber Minor ticks per major tick The number of minor ticks be-
tween two major ticksall of the following is true:
• the value is an integer
• the value is greater orequal to 0
DLI V222 Object Model Reference: 20210317T201932Z
744 CONTENTS
13.6 Properties: Y2 axis settings
object renderer/draw_plot/arguments: 4/y2/
Configuration for Y2 axis
This object does not correspond to an actual resource.
This object contains the following items:
min Minimum, if any
max Maximum, if any
softmin Soft minimum, if any
softmax Soft maximum, if any
tics Major tick interval, if any
mtics Minor ticks per major tick, if any
13.6.1 Minimum, if any
sum (optional number) renderer/draw_plot/arguments: 4/y2/min/
Minimum value to display on the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The maximum value is derived from data and the softmaximum
number Minimum Minimum value to display on the axis
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 745
13.6.2 Maximum, if any
sum (optional number) renderer/draw_plot/arguments: 4/y2/max/
Maximum value to display on the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The minimum value is derived from data and the softminimum
number Maximum Maximum value to display on the axis
13.6.3 Soft minimum, if any
sum (optional number) renderer/draw_plot/arguments: 4/y2/softmin/
Minimum value to display on the axis unless values exist below it, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None No soft maximum definednumber Soft minimum Minimum value to display on the axis unless values
exist below it
DLI V222 Object Model Reference: 20210317T201932Z
746 CONTENTS
13.6.4 Soft maximum, if any
sum (optional number) renderer/draw_plot/arguments: 4/y2/softmax/
Maximum value to display on the axis unless values exist above it, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None No soft minimum definednumber Soft maximum Maximum value to display on the axis unless values
exist above it
13.6.5 Major tick interval, if any
sum (optional number) renderer/draw_plot/arguments: 4/y2/tics/
The interval, in value units, between major ticks of the axis, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null Automatic The tick interval is derived from data and sizenumber Major tick interval The interval, in value units, between major ticks of the
axis
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 747
13.6.6 Minor ticks per major tick, if any
sum (optional number) renderer/draw_plot/arguments: 4/y2/mtics/
The number of minor ticks between two major ticks, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null None There are no minor ticksnumber Minor ticks per major tick The number of minor ticks be-
tween two major ticksall of the following is true:
• the value is an integer
• the value is greater orequal to 0
13.7 Plot data: Plot point
tuple renderer/draw_plot/arguments: 5/N/2/N/
Point to plot
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 X2 Y, if any
DLI V222 Object Model Reference: 20210317T201932Z
748 CONTENTS
13.7.1 X
number renderer/draw_plot/arguments: 5/N/2/N/1/
X coordinate to plot
This number does not correspond to an actual resource.
13.7.2 Y, if any
sum (variant) renderer/draw_plot/arguments: 5/N/2/N/2/
Y coordinate to plot, if any
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant false None Data for this X position is absent
number Y Y coordinate to plot
13.8 Plotted quantities and units: X axis quantity and unit
object renderer/draw_plot/arguments: 5/N/4/1/
The quantity and unit for X axis
This object does not correspond to an actual resource.
This object contains the following items:
quantity X axis quantity
unit X axis unit
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 749
13.8.1 X axis quantity
string renderer/draw_plot/arguments: 5/N/4/1/quantity/
The quantity for X axis
X axis quantity
check
Known quantities[element]:Quantity
check
The value is subject to the following constraints: known quantities[the value]
This string does not correspond to an actual resource.
13.8.2 X axis unit
string renderer/draw_plot/arguments: 5/N/4/1/unit/
The unit for X axis
X axis unit
Known quantities[element]:Quantity
check
X axis quantity
check
DLI V222 Object Model Reference: 20210317T201932Z
750 CONTENTS
The value is subject to the following constraints: known quantities[X axis quantity].units[the value]
This string does not correspond to an actual resource.
13.9 Plotted quantities and units: Y axis quantity and unit
object renderer/draw_plot/arguments: 5/N/4/2/
The quantity and unit for Y axis
This object does not correspond to an actual resource.
This object contains the following items:
quantity Y axis quantity
unit Y axis unit
13.9.1 Y axis quantity
string renderer/draw_plot/arguments: 5/N/4/2/quantity/
The quantity for Y axis
Y axis quantity
check
Known quantities[element]:Quantity
check
The value is subject to the following constraints: known quantities[the value]
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 751
13.9.2 Y axis unit
string renderer/draw_plot/arguments: 5/N/4/2/unit/
The unit for Y axis
Y axis unit
Known quantities[element]:Quantity
check
Y axis quantity
check
The value is subject to the following constraints: known quantities[Y axis quantity].units[the value]
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
752 CONTENTS
13.10 Lines: Line
tuple renderer/draw_plot/arguments: 5/N/
Plot data line settings
Plot data[element]:Plot point
Stylestyle:Line styletype:Line typecolor:Line colorwidth:Line widthmarker:Marker typesize:Marker sizeaxes:Base axes
Plotted quantities and units0:X axis quantity and unit1:Y axis quantity and unit
Line0:Title1:Plot data2:Style3:Plotted quantities and units
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 Title2 Plot data3 Style
4 Plotted quantities and units
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 753
13.10.1 Title
string renderer/draw_plot/arguments: 5/N/1/
Plot line title
This string does not correspond to an actual resource.
13.10.2 Plot data
array renderer/draw_plot/arguments: 5/N/2/
Data to plot
Plot point0:X1:Y, if any
Plot data[element]:Plot point 0..*
This array does not correspond to an actual resource.
This array contains Plot point elements.
See also Plot data: Plot point
DLI V222 Object Model Reference: 20210317T201932Z
754 CONTENTS
13.10.3 Style
object renderer/draw_plot/arguments: 5/N/3/
Style of the plot line
This object does not correspond to an actual resource.
This object contains the following items:
style Line style
type Line type
color Line colorwidth Line widthmarker Marker type
size Marker sizeaxes Base axes
13.10.3.1 Line style
string renderer/draw_plot/arguments: 5/N/3/style/
The style of the line
Line style Plot styles[element]:Name
check
The value is subject to the following constraints: plot styles[the value]
This string does not correspond to an actual resource.
13.10.3.2 Line type
string renderer/draw_plot/arguments: 5/N/3/type/
The type of the line
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 755
Line type Line types[element]:Name
check
The value is subject to the following constraints: line types[the value]
This string does not correspond to an actual resource.
13.10.3.3 Line color
string renderer/draw_plot/arguments: 5/N/3/color/
The color of the line
The value is subject to the following constraints: the value matches ∧[0-9A-F]{6}$
This string does not correspond to an actual resource.
13.10.3.4 Line width
number renderer/draw_plot/arguments: 5/N/3/width/
The width of the line
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
This number does not correspond to an actual resource.
13.10.3.5 Marker type
string renderer/draw_plot/arguments: 5/N/3/marker/
The type of the marker
DLI V222 Object Model Reference: 20210317T201932Z
756 CONTENTS
Marker type Marker types[element]:Name
check
The value is subject to the following constraints: marker types[the value]
This string does not correspond to an actual resource.
13.10.3.6 Marker size
number renderer/draw_plot/arguments: 5/N/3/size/
The size of the markers
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
This number does not correspond to an actual resource.
13.10.3.7 Base axes
string renderer/draw_plot/arguments: 5/N/3/axes/
The axes on which the line should be plotted. Units of lines plotted on the same axes must match
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 757
Base axes Axes[element]:Name
check
The value is subject to the following constraints: axes[the value]
This string does not correspond to an actual resource.
13.10.4 Plotted quantities and units
tuple renderer/draw_plot/arguments: 5/N/4/
Quantities and units to be plotted
X axis quantity and unitquantity:X axis quantityunit:X axis unit
Y axis quantity and unitquantity:Y axis quantityunit:Y axis unit
Plotted quantities and units0:X axis quantity and unit1:Y axis quantity and unit
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 X axis quantity and unit
2 Y axis quantity and unit
DLI V222 Object Model Reference: 20210317T201932Z
758 CONTENTS
See also Plotted quantities and units: X axis quantity and unit
See also Plotted quantities and units: Y axis quantity and unit
13.11 Draw a pie meter
call renderer/draw_pie_meter/
Generate a multi-sector meter image with an arrow indicating value
Propertiescolor:Arrow colorscale:Display scaledecimals:Decimalsmin_value:Minimum valuesectors:Meter sectors
Value quantity and unitquantity:Value quantityunit:Value unit
Draw a pie meter
argument
argument
Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if not administrative user
The call accepts the following arguments:
1. Format: string
2. Width: number
3. Height: number
4. Properties: object "Properties"
5. Value: number
6. Value quantity and unit: object "Value quantity and unit"
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 759
The call returns the following results:
1. Content type: string
2. Image data: string
Sample curl invocation:
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H ←↩↪→ "Accept: application/json" --data-binary "[\"gif\",5120,1536,{\"decimals ←↩↪→ \":0,\"scale\":\"log\",\"sectors\":[{\"value\":63,\"name\":\"Low\",\"color ←↩↪→ \":\"81CDC1\"},{\"value\":72,\"name\":\"Medium\",\"color\":\"CD1C26\"},{\" ←↩↪→ value\":102,\"name\":\"High\",\"color\":\"1F9B65\"}],\"min_value\":33,\" ←↩↪→ color\":\"C4BD19\"},55]" "http://192.168.0.100/restapi/renderer/ ←↩↪→ draw_pie_meter/"
⇒"<binary data of type image/jpeg>"
Sample requests invocation:
print(requests.post('http://192.168.0.100/restapi/renderer/draw_pie_meter/',auth= ←↩↪→ auth,headers=headers,json=['gif', 2560, 64, {'decimals': 0, 'scale': ' ←↩↪→ linear', 'sectors': [{'value': 47, 'name': 'Low', 'color': '7D00A1'}, {' ←↩↪→ value': 66, 'name': 'Medium', 'color': '47F0FB'}, {'value': 93, 'name': ' ←↩↪→ High', 'color': '15DFA1'}], 'min_value': 26, 'color': 'B0A80A'}, 30]).json ←↩↪→ ())
⇒'<binary data of type image/svg+xml>'
Browse more samples
13.11.1 Format
string renderer/draw_pie_meter/arguments: 1/
Image format
DLI V222 Object Model Reference: 20210317T201932Z
760 CONTENTS
Format Image formats[element]:Name
check
The value is subject to the following constraints: image formats[the value]
This string does not correspond to an actual resource.
13.11.2 Width
number renderer/draw_pie_meter/arguments: 2/
The width of the image
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
This number does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 761
13.11.3 Height
number renderer/draw_pie_meter/arguments: 3/
The height of the image
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
This number does not correspond to an actual resource.
13.11.4 Properties
object renderer/draw_pie_meter/arguments: 4/
Properties of the meter
Meter sectors[element]:Sector parameters
Propertiescolor:Arrow colorscale:Display scaledecimals:Decimalsmin_value:Minimum valuesectors:Meter sectors
This object does not correspond to an actual resource.
This object contains the following items:
color Arrow colorscale Display scale
decimals Decimalsmin_value Minimum valuesectors Meter sectors
See also Properties: Arrow color
DLI V222 Object Model Reference: 20210317T201932Z
762 CONTENTS
See also Properties: Display scale
See also Properties: Decimals
See also Properties: Minimum value
See also Properties: Meter sectors
13.11.5 Value
number renderer/draw_pie_meter/arguments: 5/
Meter value to display
This number does not correspond to an actual resource.
See also Draw a pie meter: Value quantity and unit
13.11.6 Content type
string renderer/draw_pie_meter/results: 1/
The content type of the generated image
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 763
13.11.7 Image data
string renderer/draw_pie_meter/results: 2/
Generated image data
Image data Content typecontent
The value contains content type data.
This string does not correspond to an actual resource.
13.12 Properties: Arrow color
string renderer/draw_pie_meter/arguments: 4/color/
The color of the meter arrow
The value is subject to the following constraints: the value matches ∧[0-9A-F]{6}$
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
764 CONTENTS
13.13 Properties: Display scale
string renderer/draw_pie_meter/arguments: 4/scale/
The scale function to use for display
Display scale Plot scales[element]:Name
check
The value is subject to the following constraints: plot scales[the value]
This string does not correspond to an actual resource.
13.14 Properties: Decimals
number renderer/draw_pie_meter/arguments: 4/decimals/
Number of decimal places to show in displayed value
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater or equal to 0
This number does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 765
13.15 Properties: Minimum value
number renderer/draw_pie_meter/arguments: 4/min_value/
The minimum value to be displayed on the meter
This number does not correspond to an actual resource.
13.16 Properties: Meter sectors
array renderer/draw_pie_meter/arguments: 4/sectors/
Parameters of meter sectors
Sector parametersname:Namevalue:Maximum valuecolor:Color
Meter sectors[element]:Sector parameters 0..*
This array does not correspond to an actual resource.
This array contains Sector parameters elements.
DLI V222 Object Model Reference: 20210317T201932Z
766 CONTENTS
13.16.1 Sector parameters
object renderer/draw_pie_meter/arguments: 4/sectors/N/
Parameters of a meter sector
This object does not correspond to an actual resource.
This object contains the following items:
name Namevalue Maximum valuecolor Color
13.16.1.1 Name
string renderer/draw_pie_meter/arguments: 4/sectors/N/name/
The name of the sector
This string does not correspond to an actual resource.
13.16.1.2 Maximum value
number renderer/draw_pie_meter/arguments: 4/sectors/N/value/
The maximum value for the sector
This number does not correspond to an actual resource.
13.16.1.3 Color
string renderer/draw_pie_meter/arguments: 4/sectors/N/color/
The color of the sector
The value is subject to the following constraints: the value matches ∧[0-9A-F]{6}$
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 767
13.17 Draw a pie meter: Value quantity and unit
object renderer/draw_pie_meter/arguments: 6/
The quantity and unit for value
This object does not correspond to an actual resource.
This object contains the following items:
quantity Value quantity
unit Value unit
13.17.1 Value quantity
string renderer/draw_pie_meter/arguments: 6/quantity/
The quantity for value
Value quantity
check
Known quantities[element]:Quantity
check
The value is subject to the following constraints: known quantities[the value]
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
768 CONTENTS
13.17.2 Value unit
string renderer/draw_pie_meter/arguments: 6/unit/
The unit for value
Value unit
Known quantities[element]:Quantity
check
Value quantity
check
The value is subject to the following constraints: known quantities[value quantity].units[the value]
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 769
13.18 Draw a message
call renderer/draw_message/
Generate an image with a message in its center
Draw a message Administrative userAdministratorRegular user
can_invoke
Performing the function call is denied if not administrative user
The call accepts the following arguments:
1. Format: string
2. Width: number
3. Height: number
4. Message: string
The call returns the following results:
1. Content type: string
2. Image data: string
Sample JS request invocation:
request.post({url:"renderer/draw_message/",body:["svg",320,7680,"Message!"]});
⇒"<binary data of type image/png>"
Sample uom library invocation:
print(uom.dump(uom.renderer.draw_message("png",384,256,"Message!")))
⇒"<binary data of type image/gif>"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
770 CONTENTS
13.18.1 Format
string renderer/draw_message/arguments: 1/
Image format
Format Image formats[element]:Name
check
The value is subject to the following constraints: image formats[the value]
This string does not correspond to an actual resource.
13.18.2 Width
number renderer/draw_message/arguments: 2/
The width of the image
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
This number does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 771
13.18.3 Height
number renderer/draw_message/arguments: 3/
The height of the image
The value represents screen length, the standard unit of which is the pixel (px).
The value is subject to the following constraints: all of the following is true:
• the value is an integer
• the value is greater than 0
This number does not correspond to an actual resource.
13.18.4 Message
string renderer/draw_message/arguments: 4/
Message text
This string does not correspond to an actual resource.
13.18.5 Content type
string renderer/draw_message/results: 1/
The content type of the generated image
This string does not correspond to an actual resource.
DLI V222 Object Model Reference: 20210317T201932Z
772 CONTENTS
13.18.6 Image data
string renderer/draw_message/results: 2/
Generated image data
Image data Content typecontent
The value contains content type data.
This string does not correspond to an actual resource.
13.19 Plot styles
map renderer/known_plot_styles/
Known plot styles
Plot styles[element]:Name
check
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name elements.
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 773
Creating elements in this collection is not supported.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/renderer/known_plot_styles/', ←↩↪→ auth=auth,headers=headers).json())
⇒
Sample JS request read command:
request.get({url:"renderer/known_plot_styles/"},function(error,response,body) { ←↩↪→ console.log(body)});
⇒
Browse more samples
13.19.1 Name
string renderer/known_plot_styles/S/
Name of plot style
Name Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample CLI read command (note that name is a variable):
uom get "renderer/known_plot_styles/${name}"
⇒
"Lines only"
DLI V222 Object Model Reference: 20210317T201932Z
774 CONTENTS
Sample requests read command (note that _name is a variable):
print(requests.get('http://192.168.0.100/restapi/renderer/known_plot_styles/'+ ←↩↪→ _name+'/',auth=auth,headers=headers).json())
⇒'Approximated spline smoothed lines'
Browse more samples
13.20 Plot scales
map renderer/known_scales/
Known plot scales
Plot scales[element]:Name
check
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name elements.
Creating elements in this collection is not supported.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/renderer/known_scales/',auth= ←↩↪→ auth,headers=headers).json())
⇒{'linear': 'linear', 'log': 'logarithmic'}
Sample uom library read command:
print(uom.dump(uom.renderer.known_scales))
⇒{linear="linear",log="logarithmic"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 775
13.20.1 Name
string renderer/known_scales/S/
Name of plot scale
Name Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample CLI read command (note that name is a variable):
uom get "renderer/known_scales/${name}"
⇒"logarithmic"
Sample curl read command (note that :name is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/renderer/known_scales/:name/"
⇒"logarithmic"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
776 CONTENTS
13.21 Line types
map renderer/known_line_types/
Known line types
Line types[element]:Name
check
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name elements.
Creating elements in this collection is not supported.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/renderer/known_line_types/',auth ←↩↪→ =auth,headers=headers).json())
⇒{'dashed': 'Dashed', 'dotted': 'Dotted', 'solid': 'Solid'}
Sample uom library read command:
print(uom.dump(uom.renderer.known_line_types))
⇒{dashed="Dashed",dotted="Dotted",solid="Solid"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 777
13.21.1 Name
string renderer/known_line_types/S/
Name of line type
Name Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample requests read command (note that _name is a variable):
print(requests.get('http://192.168.0.100/restapi/renderer/known_line_types/'+ ←↩↪→ _name+'/',auth=auth,headers=headers).json())
⇒'Dashed'
Sample JS request read command (note that _name is a variable):
request.get({url:"renderer/known_line_types/"+_name+"/"},function(error,response, ←↩↪→ body) {console.log(body)});
⇒"Dotted"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
778 CONTENTS
13.22 Marker types
map renderer/known_marker_types/
Known marker types
Marker types[element]:Name
check
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name elements.
Creating elements in this collection is not supported.
Sample CLI read command:
uom get "renderer/known_marker_types"
⇒
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/renderer/known_marker_types/"
⇒
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 779
13.22.1 Name
string renderer/known_marker_types/S/
Name of marker type
Name Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample uom library read command (note that _name is a variable):
print(uom.dump(uom.renderer.known_marker_types[_name]))
⇒"Empty triangle"
Sample curl read command (note that :name is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/renderer/known_marker_types/:name/"
⇒"Dot"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
780 CONTENTS
13.23 Axes
map renderer/known_axes/
Known axis combinations
Axes[element]:Name
check
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name 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/renderer/known_axes/"
⇒{"x2y2":"X2, Y2","x2y1":"X2, Y1","x1y1":"X1, Y1","x1y2":"X1, Y2"}
Sample CLI read command:
uom get "renderer/known_axes"
⇒{"x2y2":"X2, Y2","x2y1":"X2, Y1","x1y1":"X1, Y1","x1y2":"X1, Y2"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 781
13.23.1 Name
string renderer/known_axes/S/
Name of axis combination
Name Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample CLI read command (note that name is a variable):
uom get "renderer/known_axes/${name}"
⇒"X2, Y1"
Sample curl read command (note that :name is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/renderer/known_axes/:name/"
⇒"X2, Y1"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
782 CONTENTS
13.24 Image formats
map renderer/known_image_formats/
Known image formats
Image formats[element]:Name
check
Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map contains Name 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/renderer/known_image_formats/"
⇒{"svg":"SVG","gif":"GIF","jpeg":"JPEG","png":"PNG"}
Sample CLI read command:
uom get "renderer/known_image_formats"
⇒{"svg":"SVG","gif":"GIF","jpeg":"JPEG","png":"PNG"}
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
13 Renderer object 783
13.24.1 Name
string renderer/known_image_formats/S/
Name of image format
Name Administrative userAdministratorRegular user
can_read
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample JS request read command (note that _name is a variable):
request.get({url:"renderer/known_image_formats/"+_name+"/"},function(error, ←↩↪→ response,body) {console.log(body)});
⇒"PNG"
Sample requests read command (note that _name is a variable):
print(requests.get('http://192.168.0.100/restapi/renderer/known_image_formats/'+ ←↩↪→ _name+'/',auth=auth,headers=headers).json())
⇒'GIF'
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
784 CONTENTS
14 Credentials
object cred/
Security attributes of agent performing request
This object contains the following items:
name Client username, if any
is_admin Administrative useroutlet_access Outlet access permissions
agent Agent identifier
ip_address Client IP address, if any
Sample CLI write command:
uom set cred "{\"ip_address\":\"192.168.0.91\",\"is_admin\":true,\"name\":\"admin ←↩↪→ \",\"agent\":\"web ui\",\"outlet_access\":[true,true,true,true,true,true, ←↩↪→ true,true]}"
Sample JS request write command:
request.put({url:"cred/",body:{"ip_address":"192.168.0.91","is_admin":true,"name ←↩↪→ ":"admin","agent":"web ui","outlet_access":[true,true,true,true,true,true, ←↩↪→ true,true]}});
Browse more samples
14.1 Client username, if any
sum (optional string) cred/name/
Username of the client, as verified by the agent, if any
This sum does not support direct modification.
This sum can assume the following values:
constant null Username absent or unknown Username could not be obtainedstring Client username Username of the client, as verified by the agent
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/cred/name/"
⇒
"admin"
Sample JS request read command:
DLI V222 Object Model Reference: 20210317T201932Z
14 Credentials 785
request.get({url:"cred/name/"},function(error,response,body) {console.log(body)}) ←↩↪→ ;
⇒"admin"
Browse more samples
14.2 Administrative user
sum (boolean) cred/is_admin/
Flag indicating whether the user is an administrator
This sum does not support direct modification.
This sum can assume the following values:
constant true Administrator The user is an administratorconstant false Regular user The user is a regular user
Sample uom library read command:
print(uom.dump(uom.cred.is_admin))
⇒true
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/cred/is_admin/',auth=auth, ←↩↪→ headers=headers).json())
⇒True
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
786 CONTENTS
14.3 Outlet access permissions
sum (variant) cred/outlet_access/
Access settings for outlets
Outlet access levels[element]:Outlet access
Outlet access permissionsFullNoneOutlet access levels 0..1
can_read,can_invoke,can_write
Outlets[element]:Outlet
check
The value is subject to the following constraints: any of the following is true:
• the value is equal to true
• the value is equal to false
• length of the value is equal to length of outlets
This sum is composite, i.e. is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
constant true Full State of all outlets can be manipulated by the user
constant false None Outlet states cannot be neither seen nor manipulatedby the user
array Outlet access levels Access levels per outlet
Sample uom library read command:
print(uom.dump(uom.cred.outlet_access))
⇒
{true,true,true,true,true,true,true,true}
Sample JS request read command:
DLI V222 Object Model Reference: 20210317T201932Z
14 Credentials 787
request.get({url:"cred/outlet_access/"},function(error,response,body) {console. ←↩↪→ log(body)});
⇒[true,true,true,true,true,true,true,true]
Browse more samples
See also Outlet access permissions: Outlet access levels
14.4 Outlet access permissions: Outlet access levels
(possibly) array cred/outlet_access/
Access levels per outlet
This array is a part of a composite value which is modified as a whole.
This array contains Outlet access elements.
Creating elements in this collection is not supported.
Browse more samples
14.4.1 Outlet access
sum (boolean) cred/outlet_access/N/
Access level for outlet by index
Outlet accessFullNone
Outlets[element]:Outlet
check
The value is subject to the following constraints: outlets[index of the value]
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:
DLI V222 Object Model Reference: 20210317T201932Z
788 CONTENTS
constant true Full Outlet state can be manipulated by the user
constant false None Outlet state cannot be neither seen nor manipulatedby the user
Sample curl read command (note that :outlet_access_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/ ←↩↪→ restapi/cred/outlet_access/:outlet_access_index/"
⇒true
Sample CLI read command (note that outlet_access_index is a variable):
uom get "cred/outlet_access/${outlet_access_index}"
⇒true
Browse more samples
14.5 Agent identifier
string cred/agent/
Identifier of the agent performing request
This string does not support direct modification.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/cred/agent/',auth=auth,headers= ←↩↪→ headers).json())
⇒'web ui'
Sample CLI read command:
uom get "cred/agent"
⇒"web ui"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z
14 Credentials 789
14.6 Client IP address, if any
sum (optional string) cred/ip_address/
IPv4 address of the client performing request, if any
This sum does not support direct modification.
This sum can assume the following values:
constant null Client IP address absent orunknown
The request is performed locally, or its origin is un-known
string Client IP address IPv4 address of the client per-forming request
the value matches ∧(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Sample JS request read command:
request.get({url:"cred/ip_address/"},function(error,response,body) {console.log( ←↩↪→ body)});
⇒"192.168.0.21"
Sample uom library read command:
print(uom.dump(uom.cred.ip_address))
⇒"192.168.0.47"
Browse more samples
DLI V222 Object Model Reference: 20210317T201932Z