DLI ISO32 Object Model Reference
|
object | config/ |
Object representing configuration server |
This object contains the following items:
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/"
⇒
...
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/config/',auth=auth,headers=headers,json=<...>)
array | config/links/ |
List of user-defined links to display in the web UI |
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 curl
link creation command:
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"description\":\"test 3\",\"href\":\"test_url5\"}" "http://192.168.0.100/restapi/config/links/"
Sample CLI read command:
uom get "config/links"
⇒
[{"description":"test 5","href":"test_url7"},{"description":"test 3","href":"test_url5"}]
See also Links list: Link
object | config/links/N/ |
User-defined link |
Retrieving the value is denied if not administrative user
This object represents a value in persistent storage.
This object contains the following items:
href | URI |
description | Description |
Sample CLI write command (note that link_index
is a variable):
uom set "config/links/${link_index}" "{\"description\":\"test 3\",\"href\":\"test_url5\"}"
Sample curl
deletion command (note that :link_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/links/:link_index/"
string | config/links/N/href/ |
The target URI of the link |
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].href="test_url7"
Sample JS request
read command (note that _link_index
is a variable):
request.get({url:"config/links/"+_link_index.toString()+"/href/"},function(error,response,body) {console.log(body)});
⇒
"test_url5"
string | config/links/N/description/ |
The textual representation of the link |
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 requests
write command (note that _link_index
is a variable):
requests.put('http://192.168.0.100/restapi/config/links/'+str(_link_index)+'/description/',auth=auth,headers=headers,json='test 3')
array | config/plots/ |
List of plots to display in the web UI |
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
read command:
request.get({url:"config/plots/"},function(error,response,body) {console.log(body)});
⇒
<...>
Sample CLI plot creation command:
uom insert "config/plots/6" "{\"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\":true,\"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}"
object | config/plots/N/ |
Configuration of plot for measured values |
This object contains the following items:
title | Title |
display | Display |
width | Width |
height | Height |
x1 | X1 axis settings |
x2 | X2 axis settings |
y1 | Y1 axis settings |
y2 | Y2 axis settings |
data | Plot lines |
Sample CLI read command (note that plot_index
is a variable):
uom get "config/plots/${plot_index}"
⇒
Sample CLI deletion command (note that plot_index
is a variable):
uom remove "config/plots/${plot_index}"
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
string | config/plots/N/title/ |
The title of the plot |
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 _plot_index
is a variable):
print(requests.get('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/title/',auth=auth,headers=headers).json())
⇒
'Bus A status'
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 "\"Battery voltage\"" "http://192.168.0.100/restapi/config/plots/:plot_index/title/"
sum (boolean) | config/plots/N/display/ |
Indicates whether the plot should be displayed |
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 read command (note that plot_index
is a variable):
uom get "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())
⇒
False
number | config/plots/N/width/ |
The width of the plot |
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:
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 _plot_index
is a variable):
print(uom.dump(uom.config.plots[_plot_index].width))
⇒
640
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/width/"
⇒
640
number | config/plots/N/height/ |
The height of the plot |
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:
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 _plot_index
is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/height/"},function(error,response,body) {console.log(body)});
⇒
480
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/height/"
⇒
480
object | config/plots/N/x1/ |
Configuration for X1 axis |
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
write command (note that _plot_index
is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/x1/",body:{"min":null,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null}});
sum (optional number) | config/plots/N/x1/min/ |
Minimum value to display on the axis, if any |
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 soft maximum | |
number | Minimum | Minimum value to display on the axis |
Sample CLI read command (note that plot_index
is a variable):
uom get "config/plots/${plot_index}/x1/min"
⇒
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/min/"
sum (optional number) | config/plots/N/x1/max/ |
Maximum value to display on the axis, if any |
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 soft minimum | |
number | Maximum | Maximum 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()+"/x1/max/"},function(error,response,body) {console.log(body)});
⇒
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)+'/x1/max/',auth=auth,headers=headers).json())
⇒
None
sum (optional number) | config/plots/N/x1/softmin/ |
Minimum value to display on the axis unless values exist below it, if any |
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 defined | |
number | Soft minimum | Minimum value to display on the axis unless values exist below it |
Sample uom
library read command (note that _plot_index
is a variable):
print(uom.dump(uom.config.plots[_plot_index].x1.softmin))
⇒
null
Sample JS request
read command (note that _plot_index
is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/x1/softmin/"},function(error,response,body) {console.log(body)});
⇒
null
sum (optional number) | config/plots/N/x1/softmax/ |
Maximum value to display on the axis unless values exist above it, if any |
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 defined | |
number | Soft maximum | Maximum value to display on the axis unless values exist above it |
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/softmax/',auth=auth,headers=headers).json())
⇒
None
Sample CLI read command (note that plot_index
is a variable):
uom get "config/plots/${plot_index}/x1/softmax"
⇒
null
sum (optional number) | config/plots/N/x1/tics/ |
The interval, in value units, between major ticks of the axis, if any |
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 size | |
number | Major tick interval | The interval, in value units, between major ticks of the axis |
Sample CLI read command (note that plot_index
is a variable):
uom get "config/plots/${plot_index}/x1/tics"
⇒
null
Sample JS request
read command (note that _plot_index
is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/x1/tics/"},function(error,response,body) {console.log(body)});
⇒
null
sum (optional number) | config/plots/N/x1/mtics/ |
The number of minor ticks between two major ticks, if any |
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 ticks | |
number | Minor ticks per major tick | The number of minor ticks between two major ticks | all of the following is true: |
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/mtics/"
⇒
null
Sample JS request
write command (note that _plot_index
is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/x1/mtics/",body:null});
object | config/plots/N/x2/ |
Configuration for X2 axis |
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 requests
write command (note that _plot_index
is a variable):
requests.put('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})
sum (optional number) | config/plots/N/x2/min/ |
Minimum value to display on the axis, if any |
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 soft maximum | |
number | Minimum | Minimum 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)+'/x2/min/',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.min))
⇒
null
sum (optional number) | config/plots/N/x2/max/ |
Maximum value to display on the axis, if any |
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 soft minimum | |
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].x2.max=null
Sample CLI read command (note that plot_index
is a variable):
uom get "config/plots/${plot_index}/x2/max"
⇒
null
sum (optional number) | config/plots/N/x2/softmin/ |
Minimum value to display on the axis unless values exist below it, if any |
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 defined | |
number | Soft minimum | Minimum value to display on the axis unless values exist below it |
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/softmin/',auth=auth,headers=headers).json())
⇒
None
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/softmin/"
⇒
null
sum (optional number) | config/plots/N/x2/softmax/ |
Maximum value to display on the axis unless values exist above it, if any |
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 defined | |
number | Soft maximum | Maximum value to display on the axis unless values exist above it |
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/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)+'/x2/softmax/',auth=auth,headers=headers,json=None)
sum (optional number) | config/plots/N/x2/tics/ |
The interval, in value units, between major ticks of the axis, if any |
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 size | |
number | 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/x2/tics/"
Sample JS request
read command (note that _plot_index
is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/x2/tics/"},function(error,response,body) {console.log(body)});
⇒
null
sum (optional number) | config/plots/N/x2/mtics/ |
The number of minor ticks between two major ticks, if any |
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 ticks | |
number | Minor ticks per major tick | The number of minor ticks between two major ticks | all of the following is 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)+'/x2/mtics/',auth=auth,headers=headers).json())
⇒
None
Sample requests
write command (note that _plot_index
is a variable):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/x2/mtics/',auth=auth,headers=headers,json=None)
object | config/plots/N/y1/ |
Configuration for Y1 axis |
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 JS request
read command (note that _plot_index
is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/y1/"},function(error,response,body) {console.log(body)});
⇒
{"min":0,"softmax":null,"max":null,"tics":null,"mtics":null,"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 "{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null}" "http://192.168.0.100/restapi/config/plots/:plot_index/y1/"
sum (optional number) | config/plots/N/y1/min/ |
Minimum value to display on the axis, if any |
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 soft maximum | |
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/y1/min/"
⇒
0
Sample uom
library read command (note that _plot_index
is a variable):
print(uom.dump(uom.config.plots[_plot_index].y1.min))
⇒
0
sum (optional number) | config/plots/N/y1/max/ |
Maximum value to display on the axis, if any |
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 soft minimum | |
number | Maximum | Maximum 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()+"/y1/max/",body:null});
Sample CLI read command (note that plot_index
is a variable):
uom get "config/plots/${plot_index}/y1/max"
⇒
null
sum (optional number) | config/plots/N/y1/softmin/ |
Minimum value to display on the axis unless values exist below it, if any |
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 defined | |
number | Soft minimum | Minimum value to display on the axis unless values exist below it |
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/softmin/',auth=auth,headers=headers,json=None)
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/y1/softmin/"
sum (optional number) | config/plots/N/y1/softmax/ |
Maximum value to display on the axis unless values exist above it, if any |
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 defined | |
number | 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 uom
library read command (note that _plot_index
is a variable):
print(uom.dump(uom.config.plots[_plot_index].y1.softmax))
⇒
null
sum (optional number) | config/plots/N/y1/tics/ |
The interval, in value units, between major ticks of the axis, if any |
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 size | |
number | Major tick interval | The interval, in value units, between major ticks of the axis |
Sample CLI write command (note that plot_index
is a variable):
uom set "config/plots/${plot_index}/y1/tics" "null"
Sample uom
library write command (note that _plot_index
is a variable):
uom.config.plots[_plot_index].y1.tics=null
sum (optional number) | config/plots/N/y1/mtics/ |
The number of minor ticks between two major ticks, if any |
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 ticks | |
number | Minor ticks per major tick | The number of minor ticks between two major ticks | all of the following is true: |
Sample JS request
read command (note that _plot_index
is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/y1/mtics/"},function(error,response,body) {console.log(body)});
⇒
null
Sample CLI write command (note that plot_index
is a variable):
uom set "config/plots/${plot_index}/y1/mtics" "null"
object | config/plots/N/y2/ |
Configuration for Y2 axis |
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 JS request
read command (note that _plot_index
is a variable):
request.get({url:"config/plots/"+_plot_index.toString()+"/y2/"},function(error,response,body) {console.log(body)});
⇒
{"min":0,"softmax":1,"max":null,"tics":null,"mtics":null,"softmin":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/y2/"
⇒
{"min":null,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null}
sum (optional number) | config/plots/N/y2/min/ |
Minimum value to display on the axis, if any |
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 soft maximum | |
number | Minimum | Minimum value to display on 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)+'/y2/min/',auth=auth,headers=headers).json())
⇒
None
Sample CLI read command (note that plot_index
is a variable):
uom get "config/plots/${plot_index}/y2/min"
⇒
0
sum (optional number) | config/plots/N/y2/max/ |
Maximum value to display on the axis, if any |
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 soft minimum | |
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].y2.max=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/y2/max/"
sum (optional number) | config/plots/N/y2/softmin/ |
Minimum value to display on the axis unless values exist below it, if any |
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 defined | |
number | Soft minimum | Minimum value to display on the axis unless values exist below it |
Sample CLI read command (note that plot_index
is a variable):
uom get "config/plots/${plot_index}/y2/softmin"
⇒
null
Sample JS request
write command (note that _plot_index
is a variable):
request.put({url:"config/plots/"+_plot_index.toString()+"/y2/softmin/",body:null});
sum (optional number) | config/plots/N/y2/softmax/ |
Maximum value to display on the axis unless values exist above it, if any |
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 defined | |
number | 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))
⇒
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/y2/softmax/"
⇒
null
sum (optional number) | config/plots/N/y2/tics/ |
The interval, in value units, between major ticks of the axis, if any |
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 size | |
number | 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)+'/y2/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].y2.tics))
⇒
null
sum (optional number) | config/plots/N/y2/mtics/ |
The number of minor ticks between two major ticks, if any |
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 ticks | |
number | Minor ticks per major tick | The number of minor ticks between two major ticks | all of the following is true: |
Sample CLI write command (note that plot_index
is a variable):
uom set "config/plots/${plot_index}/y2/mtics" "null"
Sample uom
library read command (note that _plot_index
is a variable):
print(uom.dump(uom.config.plots[_plot_index].y2.mtics))
⇒
null
object | config/plots/N/data/N/style/ |
Style of the plot line |
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 color |
width | Line width |
marker | Marker type |
size | Marker size |
axes | Base axes |
Sample uom
library read command (note that _plot_index
and _plot_line_configuration_index
are variables):
print(uom.dump(uom.config.plots[_plot_index].data[_plot_line_configuration_index].style))
⇒
{axes="x1y1",color="FF0000",marker="plus",size=0,style="lines",type="solid",width=1}
Sample CLI read command (note that plot_index
and plot_line_configuration_index
are variables):
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}
string | config/plots/N/data/N/style/style/ |
The style of the line |
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
are URL 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
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 "\"lines\"" "http://192.168.0.100/restapi/config/plots/:plot_index/data/:plot_line_configuration_index/style/style/"
string | config/plots/N/data/N/style/type/ |
The type of the line |
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 write command (note that _plot_index
and _plot_line_configuration_index
are variables):
uom.config.plots[_plot_index].data[_plot_line_configuration_index].style.type="solid"
Sample requests
write command (note that _plot_index
and _plot_line_configuration_index
are variables):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/data/'+str(_plot_line_configuration_index)+'/style/type/',auth=auth,headers=headers,json='solid')
string | config/plots/N/data/N/style/color/ |
The color of the line |
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
read command (note that _plot_index
and _plot_line_configuration_index
are variables):
request.get({url:"config/plots/"+_plot_index.toString()+"/data/"+_plot_line_configuration_index.toString()+"/style/color/"},function(error,response,body) {console.log(body)});
⇒
"FF0000"
Sample CLI read command (note that plot_index
and plot_line_configuration_index
are variables):
uom get "config/plots/${plot_index}/data/${plot_line_configuration_index}/style/color"
⇒
"FF0000"
number | config/plots/N/data/N/style/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:
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/width/",body:1});
Sample requests
read command (note that _plot_index
and _plot_line_configuration_index
are variables):
print(requests.get('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/data/'+str(_plot_line_configuration_index)+'/style/width/',auth=auth,headers=headers).json())
⇒
1
string | config/plots/N/data/N/style/marker/ |
The type of the marker |
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 CLI write command (note that plot_index
and plot_line_configuration_index
are variables):
uom set "config/plots/${plot_index}/data/${plot_line_configuration_index}/style/marker" "\"plus\""
Sample uom
library read command (note that _plot_index
and _plot_line_configuration_index
are variables):
print(uom.dump(uom.config.plots[_plot_index].data[_plot_line_configuration_index].style.marker))
⇒
"plus"
number | config/plots/N/data/N/style/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:
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
are URL 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/size/"
⇒
0
Sample JS request
read command (note that _plot_index
and _plot_line_configuration_index
are variables):
request.get({url:"config/plots/"+_plot_index.toString()+"/data/"+_plot_line_configuration_index.toString()+"/style/size/"},function(error,response,body) {console.log(body)});
⇒
0
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 |
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 write command (note that plot_index
and plot_line_configuration_index
are variables):
uom set "config/plots/${plot_index}/data/${plot_line_configuration_index}/style/axes" "\"x1y1\""
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/axes/",body:"x1y2"});
array | config/plots/N/data/ |
Configurations of values to plot |
This array is composite, i.e. is modified as a whole.
This array contains Plot line configuration elements.
Sample uom
library write command (note that _plot_index
is a variable):
uom.config.plots[_plot_index].data={{ds="battery_voltage",style={axes="x1y1",color="FF0000",marker="plus",size=0,style="lines",type="solid",width=1},title="Battery voltage"}}
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/data/"
⇒
object | config/plots/N/data/N/ |
Properties of a plot line |
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
ds | Data source |
title | Title |
style | Style |
Sample CLI write command (note that plot_index
and plot_line_configuration_index
are variables):
uom set "config/plots/${plot_index}/data/${plot_line_configuration_index}" "{\"ds\":\"buses.1.total_energy\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"0000FF\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size\":0},\"title\":\"Bus B total energy\"}"
Sample curl
write command (note that :plot_index
and :plot_line_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 "{\"ds\":\"relay_voltage\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"FF0000\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size\":0},\"title\":\"Relay voltage\"}" "http://192.168.0.100/restapi/config/plots/:plot_index/data/:plot_line_configuration_index/"
string | config/plots/N/data/N/ds/ |
Identifier of the data source to use |
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 CLI write command (note that plot_index
and plot_line_configuration_index
are variables):
uom set "config/plots/${plot_index}/data/${plot_line_configuration_index}/ds" "\"battery_voltage\""
Sample curl
read command (note that :plot_index
and :plot_line_configuration_index
are URL 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/ds/"
⇒
"buses.0.total_energy"
string | config/plots/N/data/N/title/ |
The title of the plot line |
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 curl
read command (note that :plot_index
and :plot_line_configuration_index
are URL 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/title/"
⇒
"Power voltage"
Sample requests
write command (note that _plot_index
and _plot_line_configuration_index
are variables):
requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/data/'+str(_plot_line_configuration_index)+'/title/',auth=auth,headers=headers,json='Bus A voltage')
See also Plot line configuration: Style
array | config/meters/ |
List of meters to display in the web UI |
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 requests
meter configuration creation command:
requests.post('http://192.168.0.100/restapi/config/meters/',auth=auth,headers=headers,json={'decimals': 1, 'color': '', 'sectors': [{'color': '0000FF', 'name': 'Low', 'value': 10}, {'color': '00FF00', 'name': 'Optimal', 'value': 13}, {'color': 'FF0000', 'name': 'High', 'value': 15}], 'data': 'relay_voltage', 'width': 128, 'title': 'Relay voltage', 'display': True, 'min_value': 8, 'scale': 'linear', 'height': 64})
Sample curl
meter configuration creation command:
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"decimals\":2,\"color\":\"\",\"sectors\":[{\"color\":\"0000FF\",\"name\":\"Low\",\"value\":4.9},{\"color\":\"00FF00\",\"name\":\"Optimal\",\"value\":5.5},{\"color\":\"FF0000\",\"name\":\"High\",\"value\":6}],\"data\":\"power_voltage\",\"width\":128,\"title\":\"Power voltage\",\"display\":true,\"min_value\":4,\"scale\":\"linear\",\"height\":64}" "http://192.168.0.100/restapi/config/meters/"
object | config/meters/N/ |
Configuration of meter for a measured value |
This object contains the following items:
title | Title |
display | Display |
data | Data source |
width | Width |
height | Height |
scale | Display scale |
decimals | Decimals |
color | Arrow color |
min_value | Minimum value |
sectors | Meter sectors |
Sample CLI read command (note that meter_configuration_index
is a variable):
uom get "config/meters/${meter_configuration_index}"
⇒
Sample uom
library write command (note that _meter_configuration_index
is a variable):
uom.config.meters[_meter_configuration_index]={color="",data="environment.temperature",decimals=0,display=true,height=64,min_value=244,scale="linear",sectors={{color="0000FF",name="Cold",value=273},{color="00FF00",name="Optimal",value=322},{color="FF0000",name="Hot",value=366}},title="Temperature",width=128}
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
string | config/meters/N/title/ |
The title of the meter |
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)+'/title/',auth=auth,headers=headers,json='Battery voltage')
Sample requests
read command (note that _meter_configuration_index
is a variable):
print(requests.get('http://192.168.0.100/restapi/config/meters/'+str(_meter_configuration_index)+'/title/',auth=auth,headers=headers).json())
⇒
'Temperature'
sum (boolean) | config/meters/N/display/ |
Indicates whether the meter should be displayed |
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 shown | |
constant false | Hidden | The meter is hidden |
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 "false" "http://192.168.0.100/restapi/config/meters/:meter_configuration_index/display/"
Sample JS request
read command (note that _meter_configuration_index
is a variable):
request.get({url:"config/meters/"+_meter_configuration_index.toString()+"/display/"},function(error,response,body) {console.log(body)});
⇒
true
string | config/meters/N/data/ |
Identifier of the data source to use |
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='buses.1.voltage')
Sample uom
library write command (note that _meter_configuration_index
is a variable):
uom.config.meters[_meter_configuration_index].data="buses.0.voltage"
number | config/meters/N/width/ |
The width of the meter |
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:
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()+"/width/"},function(error,response,body) {console.log(body)});
⇒
128
Sample uom
library read command (note that _meter_configuration_index
is a variable):
print(uom.dump(uom.config.meters[_meter_configuration_index].width))
⇒
128
number | config/meters/N/height/ |
The height of the meter |
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:
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"
string | config/meters/N/scale/ |
The scale function to use for display |
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 requests
read command (note that _meter_configuration_index
is a variable):
print(requests.get('http://192.168.0.100/restapi/config/meters/'+str(_meter_configuration_index)+'/scale/',auth=auth,headers=headers).json())
⇒
'log'
Sample uom
library write command (note that _meter_configuration_index
is a variable):
uom.config.meters[_meter_configuration_index].scale="linear"
number | config/meters/N/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:
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 (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/"
⇒
0
Sample uom
library read command (note that _meter_configuration_index
is a variable):
print(uom.dump(uom.config.meters[_meter_configuration_index].decimals))
⇒
1
string | config/meters/N/color/ |
The color of the meter arrow |
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
read command (note that _meter_configuration_index
is a variable):
request.get({url:"config/meters/"+_meter_configuration_index.toString()+"/color/"},function(error,response,body) {console.log(body)});
⇒
""
Sample uom
library write command (note that _meter_configuration_index
is a variable):
uom.config.meters[_meter_configuration_index].color=""
number | config/meters/N/min_value/ |
The minimum value to be displayed on the meter |
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()+"/min_value/",body:0});
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/min_value/"
⇒
0
array | config/meters/N/sectors/ |
Configuration of meter sectors |
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 read command (note that meter_configuration_index
is a variable):
uom get "config/meters/${meter_configuration_index}/sectors"
⇒
[{"color":"00FF00","name":"Optimal","value":12},{"color":"FF0000","name":"High","value":15}]
Sample requests
sector configuration creation command (note that _meter_configuration_index
is a variable):
requests.post('http://192.168.0.100/restapi/config/meters/'+str(_meter_configuration_index)+'/sectors/',auth=auth,headers=headers,json={'color': 'FF0000', 'name': 'High', 'value': 15})
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 | Name |
value | Maximum value |
color | Color |
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]))
⇒
{color="00FF00",name="Optimal",value=127}
Sample curl
write 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/"
string | config/meters/N/sectors/N/name/ |
The name of the sector |
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 read command (note that meter_configuration_index
and sector_configuration_index
are variables):
uom get "config/meters/${meter_configuration_index}/sectors/${sector_configuration_index}/name"
⇒
"Low"
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].name="Low"
number | config/meters/N/sectors/N/value/ |
The maximum value for the sector |
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 _meter_configuration_index
and _sector_configuration_index
are variables):
request.put({url:"config/meters/"+_meter_configuration_index.toString()+"/sectors/"+_sector_configuration_index.toString()+"/value/",body:127});
Sample JS request
read command (note that _meter_configuration_index
and _sector_configuration_index
are variables):
request.get({url:"config/meters/"+_meter_configuration_index.toString()+"/sectors/"+_sector_configuration_index.toString()+"/value/"},function(error,response,body) {console.log(body)});
⇒
10
string | config/meters/N/sectors/N/color/ |
The color of the sector |
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
read command (note that _meter_configuration_index
and _sector_configuration_index
are variables):
request.get({url:"config/meters/"+_meter_configuration_index.toString()+"/sectors/"+_sector_configuration_index.toString()+"/color/"},function(error,response,body) {console.log(body)});
⇒
"0000FF"
Sample curl
write 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 "\"FF0000\"" "http://192.168.0.100/restapi/config/meters/:meter_configuration_index/sectors/:sector_configuration_index/color/"
string | config/contact/ |
The person or entity responsible for this unit and information on how to contact them |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
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)});
⇒
"support@example.com"
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/contact/"
⇒
"support@example.com"
map | config/contacts/ |
Contacts related to the unit in different ways |
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 curl
contact creation command:
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"phone\":null,\"fax\":null,\"name\":\"Security\",\"email\":null}" "http://192.168.0.100/restapi/config/contacts/security/"
Sample JS request
write command:
request.put({url:"config/contacts/",body:{"engineering":{"phone":"+0019616503523","fax":"+85182376180698","name":"Engineering","email":"engineering@foo.example.com"}}});
See also Related contacts: Contact
object | config/contacts/S/ |
Contact properties |
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 | Name |
Email, if any | |
phone | Phone number, if any |
fax | Fax number, if any |
Sample curl
deletion command (note that :contact
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/contacts/:contact/"
Sample JS request
deletion command (note that _contact
is a variable):
request.delete({url:"config/contacts/"+_contact+"/"});
string | config/contacts/S/name/ |
Contact name |
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 _contact
is a variable):
requests.put('http://192.168.0.100/restapi/config/contacts/'+_contact+'/name/',auth=auth,headers=headers,json='Features')
Sample JS request
write command (note that _contact
is a variable):
request.put({url:"config/contacts/"+_contact+"/name/",body:"Engineering"});
sum (optional string) | config/contacts/S/email/ |
Contact email address, if any |
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 stored | |
string | Contact email address | 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/email/"
⇒
null
Sample requests
write command (note that _contact
is a variable):
requests.put('http://192.168.0.100/restapi/config/contacts/'+_contact+'/email/',auth=auth,headers=headers,json=None)
sum (optional string) | config/contacts/S/phone/ |
Contact phone number, if any |
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 CLI write command (note that contact
is a variable):
uom set "config/contacts/${contact}/phone" "\"+56216606602978\""
Sample curl
write command (note that :contact
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 "\"+993669976142606\"" "http://192.168.0.100/restapi/config/contacts/:contact/phone/"
sum (optional string) | config/contacts/S/fax/ |
Contact fax number, if any |
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 stored | |
string | Fax number | Contact fax number | the value is not equal to "" |
Sample CLI read command (note that contact
is a variable):
uom get "config/contacts/${contact}/fax"
⇒
"+868592440754545"
Sample uom
library read command (note that _contact
is a variable):
print(uom.dump(uom.config.contacts[_contact].fax))
⇒
null
string | config/location/ |
The physical location of this unit (e.g. '1st floor, rack 9') |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample uom
library write command:
uom.config.location="Server room"
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/location/',auth=auth,headers=headers).json())
⇒
'Server room'
string | config/oid/ |
Object identifier of unit model (should be registered under dliRegistration OID) |
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"
string | config/version/ |
Version number of frontend software |
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.version))
⇒
"1.8.1.0"
Sample JS request
read command:
request.get({url:"config/version/"},function(error,response,body) {console.log(body)});
⇒
"1.8.1.0"
string | config/hardware_id/ |
Identifier of unit hardware model |
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.hardware_id))
⇒
"EPCR5"
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/hardware_id/"
⇒
"EPCR5"
string | config/serial/ |
Unit's serial number |
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/serial/"
⇒
"ISO322203123456"
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/serial/',auth=auth,headers=headers).json())
⇒
'ISO322203123456'
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 CLI read command:
uom get "config/outlet_label"
⇒
"Outlet"
string | config/brand_company_name/ |
The name of the company which produced the device |
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_company_name))
⇒
"Digital Loggers, Inc."
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/brand_company_name/',auth=auth,headers=headers).json())
⇒
'Digital Loggers, Inc.'
string | config/brand_name/ |
Default brand name, unless overridden |
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_name))
⇒
"Ethernet Power Controller"
Sample CLI read command:
uom get "config/brand_name"
⇒
"Ethernet Power Controller"
string | config/brand_url/ |
Default brand URL, unless overridden |
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_url/"
⇒
"https://baz.example.com:8443/baz/quux/foo/bar/bar/foo/quux/quux/foo/bar/quux/quux.html"
Sample JS request
read command:
request.get({url:"config/brand_url/"},function(error,response,body) {console.log(body)});
⇒
"http://baz.example.com:9/quux/quux/foo.html"
string | config/brand_manual_url/ |
Brand product manual URL |
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_manual_url/',auth=auth,headers=headers).json())
⇒
'http://baz.example.com:1/foo/quux/baz/baz/quux/quux/bar.htm'
Sample uom
library read command:
print(uom.dump(uom.config.brand_manual_url))
⇒
"https://baz.example.com:443/baz/quux/bar/foo/baz.html"
string | config/brand_faq_url/ |
Brand product FAQ URL |
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_faq_url))
⇒
"http://foo.example.com:80/foo.html"
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/brand_faq_url/"
⇒
"https://baz.example.com/quux/foo.html"
string | config/brand_product_info_url/ |
Brand product information URL |
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_product_info_url"
⇒
"http://foo.example.com/baz/quux/baz.htm"
Sample JS request
read command:
request.get({url:"config/brand_product_info_url/"},function(error,response,body) {console.log(body)});
⇒
"https://foo.example.com:8443/bar.html"
string | config/support_email/ |
Product support email |
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/support_email/"},function(error,response,body) {console.log(body)});
⇒
"support@example.com"
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/support_email/',auth=auth,headers=headers).json())
⇒
'support@example.com'
string | config/register_url/ |
Default registration URL, unless overridden |
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/register_url"
⇒
"http://foo.example.com:80/baz.htm"
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/register_url/',auth=auth,headers=headers).json())
⇒
'http://bar.example.com/baz/foo/quux/baz/quux.html'
string | config/support_url/ |
Default support URL, unless overridden |
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://foo.example.com:58443/quux.htm"
Sample uom
library read command:
print(uom.dump(uom.config.support_url))
⇒
"https://bar.example.com:443/bar/quux/foo/baz/quux/foo.html"
string | config/update_url/ |
Default update URL, unless overridden |
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.update_url))
⇒
"http://foo.example.com:8001/foo.html"
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/update_url/"
⇒
"https://bar.example.com/bar.htm"
sum (optional string) | config/custom_brand_company_name/ |
User-visible brand company name, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 JS request
write command:
request.put({url:"config/custom_brand_company_name/",body:"Whatever Systems Inc."});
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/custom_brand_company_name/',auth=auth,headers=headers).json())
⇒
'Whatever Systems Inc.'
sum (optional string) | config/custom_brand_name/ |
User-visible product brand name, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/custom_brand_name/"
⇒
"Amazing Controller III"
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/custom_brand_name/',auth=auth,headers=headers).json())
⇒
'Amazing Controller III'
sum (optional string) | config/custom_brand_url/ |
User-visible brand URL, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
constant null | Default | Use default brand URL | |
string | Custom brand URL | User-visible brand URL | the value is not equal to "" |
Sample JS request
read command:
request.get({url:"config/custom_brand_url/"},function(error,response,body) {console.log(body)});
⇒
"https://bar.example.com/quux/foo/bar/bar/bar/baz.html"
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://baz.example.com:80/quux/bar.htm\"" "http://192.168.0.100/restapi/config/custom_brand_url/"
sum (optional string) | config/custom_brand_logo/ |
User-visible brand logo URL, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 uom
library write command:
uom.config.custom_brand_logo="http://bar.example.com/bar/quux/bar/foo/quux.jpg"
Sample JS request
read command:
request.get({url:"config/custom_brand_logo/"},function(error,response,body) {console.log(body)});
⇒
"https://foo.example.com:8443/bar/quux.jpg"
sum (optional number) | config/custom_brand_logo_width/ |
User-visible brand logo width, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 CLI write command:
uom set "config/custom_brand_logo_width" "22"
Sample CLI read command:
uom get "config/custom_brand_logo_width"
⇒
22
sum (optional number) | config/custom_brand_logo_height/ |
User-visible brand logo height, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 uom
library read command:
print(uom.dump(uom.config.custom_brand_logo_height))
⇒
32
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/"
sum (optional string) | config/custom_support_email/ |
User-visible product support email, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 requests
write command:
requests.put('http://192.168.0.100/restapi/config/custom_support_email/',auth=auth,headers=headers,json='support@example.com')
Sample uom
library write command:
uom.config.custom_support_email="support@example.com"
sum (optional string) | config/custom_register_url/ |
User-visible registration URL, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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
read command:
print(requests.get('http://192.168.0.100/restapi/config/custom_register_url/',auth=auth,headers=headers).json())
⇒
'http://baz.example.com:8057/foo.html'
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/quux.htm\"" "http://192.168.0.100/restapi/config/custom_register_url/"
sum (optional string) | config/custom_support_url/ |
User-visible support URL, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/custom_support_url/',auth=auth,headers=headers).json())
⇒
'https://baz.example.com:443/baz.htm'
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/custom_support_url/"
⇒
"https://bar.example.com:443/bar/baz/baz/baz/baz/quux/quux/bar/quux/bar/quux/bar.htm"
sum (optional string) | config/custom_update_url/ |
User-visible update URL, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 requests
write command:
requests.put('http://192.168.0.100/restapi/config/custom_update_url/',auth=auth,headers=headers,json='http://bar.example.com/quux/baz/quux/quux.html')
Sample CLI read command:
uom get "config/custom_update_url"
⇒
"https://bar.example.com/baz/foo/baz/bar/baz.htm"
sum (optional string) | config/custom_help_url/ |
User-visible help URL, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 CLI read command:
uom get "config/custom_help_url"
⇒
"https://bar.example.com/foo/quux/foo.html"
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/baz.htm\"" "http://192.168.0.100/restapi/config/custom_help_url/"
sum (optional enumerated string) | config/customization_status/ |
Status of customization options |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 be locked | |
constant "locked" | Locked | Customization options are locked and cannot 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 "\"locked\"" "http://192.168.0.100/restapi/config/customization_status/"
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/config/customization_status/',auth=auth,headers=headers,json=None)
sum (boolean) | config/registration_status/ |
Status of the unit registration |
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 to do so | |
constant false | Undefined | The user hasn't decided on registering the unit and needs to be reminded |
Sample CLI read command:
uom get "config/registration_status"
⇒
true
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/registration_status/',auth=auth,headers=headers).json())
⇒
True
sum (boolean) | config/refresh_enabled/ |
Periodically refresh web UI status page |
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 enabled | |
constant false | Disabled | The feature is disabled |
Sample JS request
read command:
request.get({url:"config/refresh_enabled/"},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/config/refresh_enabled/"
⇒
false
number | config/refresh_delay_minutes/ |
Status page refresh delay, if refresh is enabled |
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
string | config/image_format/ |
Default image format for plots and meters |
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 requests
write command:
requests.put('http://192.168.0.100/restapi/config/image_format/',auth=auth,headers=headers,json='png')
Sample uom
library write command:
uom.config.image_format="gif"
string | config/hostname/ |
Host name of the unit (sent by DHCP client, redirected to on network configuration changes when next IP address is unknown) |
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:
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/hostname/"},function(error,response,body) {console.log(body)});
⇒
"bar.example.com"
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/hostname/',auth=auth,headers=headers).json())
⇒
'baz.example.com'
string | config/timezone/ |
System time zone |
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 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 "\"UTC\"" "http://192.168.0.100/restapi/config/timezone/"
array | config/http_ports/ |
HTTP port bindings |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 supplied more than once).
Changes to this array do not take effect immediately.
This array contains Port binding elements.
Sample uom
library port binding creation command:
local composite=uom.copy(uom.config.http_ports) uom.insert(composite,4,{address="192.168.0.7",port="8091"}) uom.config.http_ports=composite
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\":\"8089\",\"address\":\"192.168.0.3\"}" "http://192.168.0.100/restapi/config/http_ports/"
See also HTTP ports: Port binding
object | config/http_ports/N/ |
Address and port to bind service to |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 | Address |
port | Port |
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 "{\"port\":\"6\",\"address\":\"192.168.0.7\"}" "http://192.168.0.100/restapi/config/http_ports/:port_binding_index/"
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/http_ports/:port_binding_index/"
sum (string) | config/http_ports/N/address/ |
Address to listen on |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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-fA-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-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-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 CLI read command (note that port_binding_index
is a variable):
uom get "config/http_ports/${port_binding_index}/address"
⇒
"192.168.0.95"
Sample CLI write command (note that port_binding_index
is a variable):
uom set "config/http_ports/${port_binding_index}/address" "\"192.168.0.90\""
number | config/http_ports/N/port/ |
Port number to bind to |
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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="8076"
Sample CLI read command (note that port_binding_index
is a variable):
uom get "config/http_ports/${port_binding_index}/port"
⇒
"1"
array | config/https_ports/ |
HTTPS port bindings |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 supplied more 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': '80', 'address': '192.168.0.50'})
Sample CLI port binding creation command:
uom insert "config/https_ports/1" "{\"port\":\"8095\",\"address\":\"192.168.0.2\"}"
See also HTTPS ports: Port binding
object | config/https_ports/N/ |
Address and port to bind service to |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 | Address |
port | Port |
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/"
Sample CLI write command (note that port_binding_index
is a variable):
uom set "config/https_ports/${port_binding_index}" "{\"port\":\"3\",\"address\":\"192.168.0.61\"}"
sum (string) | config/https_ports/N/address/ |
Address to listen on |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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-fA-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-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-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/https_ports/'+str(_port_binding_index)+'/address/',auth=auth,headers=headers).json())
⇒
'192.168.0.16'
Sample CLI read command (note that port_binding_index
is a variable):
uom get "config/https_ports/${port_binding_index}/address"
⇒
"192.168.0.2"
number | config/https_ports/N/port/ |
Port number to bind to |
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 JS request
write command (note that _port_binding_index
is a variable):
request.put({url:"config/https_ports/"+_port_binding_index.toString()+"/port/",body:"3"});
Sample JS request
read command (note that _port_binding_index
is a variable):
request.get({url:"config/https_ports/"+_port_binding_index.toString()+"/port/"},function(error,response,body) {console.log(body)});
⇒
"80"
object | config/https_cert/ |
HTTPS certificate configuration |
Retrieving the value is denied if not administrative user
This object contains the following items:
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/config/https_cert/"
Sample CLI read command:
uom get "config/https_cert"
⇒
...
number | config/https_cert/bits/ |
Size of new private keys |
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:
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 "8192" "http://192.168.0.100/restapi/config/https_cert/bits/"
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/config/https_cert/bits/',auth=auth,headers=headers,json=4096)
map | config/https_cert/distinguished_name/ |
New certificate distinguished name elements |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 uom
library read command:
print(uom.dump(uom.config.https_cert.distinguished_name))
⇒
{commonName={"Digital Loggers Unit"},countryName={"US"},localityName={"Santa Clara"},stateOrProvinceName={"California"}}
Sample uom
library write command:
uom.config.https_cert.distinguished_name={commonName={"Digital Loggers Unit"},countryName={"US"},localityName={"Santa Clara"},stateOrProvinceName={"California"}}
See also Distinguished name: Values
sum (enumerated string) | config/https_cert/string_mask/ |
The set of string types to use for new certificates |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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
read command:
print(requests.get('http://192.168.0.100/restapi/config/https_cert/string_mask/',auth=auth,headers=headers).json())
⇒
'pkix'
Sample JS request
read command:
request.get({url:"config/https_cert/string_mask/"},function(error,response,body) {console.log(body)});
⇒
"nombstr"
sum (optional array) | config/https_cert/domains/ |
Explicit domain name list to certify for when enrolling certificate, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 certificate | |
array | Domain names override | Explicit domain name list to certify for when enrolling certificate |
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/https_cert/domains/"
⇒
null
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 "[\"baz.example.com\",\"baz.example.com\",\"baz.example.com\",\"bar.example.com\",\"baz.example.com\",\"foo.example.com\",\"bar.example.com\"]" "http://192.168.0.100/restapi/config/https_cert/domains/"
See also Domain names override, if any: Domain names override
sum (optional array) | config/https_cert/addresses/ |
Explicit list of addresses to certify for when enrolling certificate, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 certificate automatically | |
array | Addresses override | Explicit list of addresses to certify for when enrolling certificate |
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 "[\"252.6.253.0\",\"250.148.186.250\"]" "http://192.168.0.100/restapi/config/https_cert/addresses/"
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/https_cert/addresses/"
⇒
["253.59.230.252","149.99.154.78","5.254.242.74"]
See also Addresses override, if any: Addresses override
sum (boolean) | config/https_cert/automatic_renewal/ |
Automatic renewal of certificate at or near expiry |
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 enabled | |
constant false | Disabled | The feature is disabled |
Sample CLI read command:
uom get "config/https_cert/automatic_renewal"
⇒
true
Sample CLI write command:
uom set "config/https_cert/automatic_renewal" "false"
string | config/https_cert/renewal_method/ |
Method to use when renewing the certificate |
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:
This string represents a value in persistent storage.
Sample JS request
write command:
request.put({url:"config/https_cert/renewal_method/",body:"selfsigned"});
Sample uom
library read command:
print(uom.dump(uom.config.https_cert.renewal_method))
⇒
"selfsigned"
See also HTTPS certificate settings: Data
sum (variant) | config/https_cert/csr/ |
The certificate signing request to sign (read may fail if key generation is in progress) |
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 order to obtain an HTTPS certificate for the unit, to be honored by an external entity | |
constant false | Certificate signing request generation failure | No valid certificate signing request could be generated, check distinguished name settings |
Sample JS request
read command:
request.get({url:"config/https_cert/csr/"},function(error,response,body) {console.log(body)});
⇒
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-----\nMIIy0GFqRw4KunzG1JiUV10i0skYQaozIIxLbDB39IQ45PM9l4fG7i+Aakk1KZ0f\n0VEEbQY1WgSurE/XW8FWLrG5udgxIayL6Cbjf9mBrF5jW6G2HXaePtmKWTIr4GCD\nqyB0lOt1WdZfvezTEeu8QFhwZY0snFOd\n-----END CERTIFICATE REQUEST-----\n'
string | config/https_cert/cert/ |
HTTPS certificate chain presented by the unit to clients (read may fail if renewal is in progress) |
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:
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 JS request
read command:
request.get({url:"config/https_cert/cert/"},function(error,response,body) {console.log(body)});
⇒
"-----BEGIN CERTIFICATE-----\nMII6NbIipvtfCjt+wa/JQ6TzIW+yrbXn+TwN5E6wA0cOmWPi6R2ZZXYu3ZtxBQlC\nc1yk+8ndZZA+IIRMu1wTy03rzGHkUES7IQtIahyAH8AbTe+NixsgzxXzErkl5CuP\nokGWjSptfRNJRm2OfkOdIOu98fHNaj2OUKwDpm7UD=\n-----END CERTIFICATE-----\n"
Sample CLI write command:
uom set "config/https_cert/cert" "\"-----BEGIN CERTIFICATE-----\\nMIIjBRxdJeR29p72mrUS5A/ovR3uVwIU0HDDkAs3rK80AH5z9bRGnT4jxAdS7xz9\\nO+PH4GdEIqYQpk1H0rm7ajKDCTBBfRQ3SrNY80oTsMvh6z/9qnJRXfgl9tzqLPwp\\nJNRMCwFbszjr+vhnE8Lwr75l6y7XvyqFMIdbFvC7ux/utji7u33mCBXKAhu6glN2\\n1fLyuVsrWmlFUu9a+xoCV8OC2WupwzvzfGyZnqRKdCb87nl7lZLHkmWpIQeEQaE6\\nChg391jOfuXSfhEE3X/r3qAWVRz5h5+wph0/kmPPgzuMg9dljedoUpL/GL7+S7xH\\nzIclk2SjzqQ8TBt7ridg4fzRozvxwDpvYRhJV92U/VfUjYeaGHGNyFqmFmkB0a7b\\nqwZ0\\n-----END CERTIFICATE-----\\n\""
string | config/https_cert/key/ |
The key used by the HTTPS certificate presented by the unit; certificate will be renewed as a side effect of writing; writing actual data is not recommended, please use the certificate request signing path instead |
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 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 "\"-----BEGIN PRIVATE KEY-----\\nMIIzjELiQtOpIMFshvM+4b/ia0jgPtZ5bH4LYS3+LUqgt5Za1ya7Zbs9ebs3USA6\\nTJlZK64AozIOZLMAUxoN7S+/YVUldF37bqjxzp8ooSCOpaaKXOjhtjiSFDDvVI26\\no48eEySiBtY==\\n-----END PRIVATE KEY-----\\n\"" "http://192.168.0.100/restapi/config/https_cert/key/"
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/config/https_cert/key/',auth=auth,headers=headers,json='-----BEGIN PRIVATE KEY-----\nMIIo72s8mzQSq1YMdtedBziXZmm29T9DA12J6wTuvwMmzw8dqoG2o/bNnNSztdC4\nPoDvj8r5wr25Uuvnykoa7czcbtFqzy7PnMKWXBeU2ibZdXMbHACRoB3Q5LG4KQV8\nshM4Ls94Ukj16LLJZp8nvauGt/dJXo8PVXVsPgzwRi+Z4LvfA4S5gNOaO2wys5NN\nvG4cF03+0e4OamagFiNe7+3Bw132RTiMlp+1r31u==\n-----END PRIVATE KEY-----\n')
See also HTTPS certificate settings: Renew certificate
See also HTTPS certificate settings: Generate key
See also HTTPS certificate settings: Known DN OIDs
map | config/https_cert/known_renewal_methods/ |
Known renewal methods |
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 CLI read command:
uom get "config/https_cert/known_renewal_methods"
⇒
...
See also Renewal methods: Renewal method
array | config/https_cert/distinguished_name/S/ |
Distinguished name element value set |
The value is subject to the following constraints: any of the following is true:
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 JS request
deletion command (note that _values
is a variable):
request.delete({url:"config/https_cert/distinguished_name/"+_values+"/"});
Sample requests
value creation command (note that _values
is a variable):
requests.post('http://192.168.0.100/restapi/config/https_cert/distinguished_name/'+_values+'/',auth=auth,headers=headers,json='California')
string | config/https_cert/distinguished_name/S/N/ |
Distinguished name element value |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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
read command (note that _values
and _value_index
are variables):
print(requests.get('http://192.168.0.100/restapi/config/https_cert/distinguished_name/'+_values+'/'+str(_value_index)+'/',auth=auth,headers=headers).json())
⇒
'California'
Sample curl
deletion command (note that :values
and :value_index
are URL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X DELETE -H "Accept: application/json" "http://192.168.0.100/restapi/config/https_cert/distinguished_name/:values/:value_index/"
(possibly) array | config/https_cert/domains/ |
Explicit domain name list to certify for when enrolling certificate |
This array contains Hostname elements.
Sample CLI hostname creation command:
uom insert "config/https_cert/domains/0" "\"bar.example.com\""
Sample uom
library hostname creation command:
uom.insert(uom.config.https_cert.domains,2,"baz.example.com")
string | config/https_cert/domains/N/ |
Hostname to certify for |
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:
This string represents a value in persistent storage.
Sample uom
library write command (note that _hostname_index
is a variable):
uom.config.https_cert.domains[_hostname_index]="foo.example.com"
Sample CLI write command (note that hostname_index
is a variable):
uom set "config/https_cert/domains/${hostname_index}" "\"bar.example.com\""
(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,4,"198.254.162.203")
Sample JS request
IPv4 address creation command:
request.post({url:"config/https_cert/addresses/",body:"198.143.5.38"});
string | config/https_cert/addresses/N/ |
IPv4 address to certify for, in dotted quad notation |
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:
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='3.152.6.140')
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/"
⇒
"133.145.147.209"
map | config/https_cert/renewal_data/ |
Renewal-method-specific data |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This map represents a value in persistent storage.
This map contains Data item elements.
Sample uom
library read command:
print(uom.dump(uom.config.https_cert.renewal_data))
⇒
{days="602455106"}
Sample CLI data item creation command:
uom insert "config/https_cert/renewal_data/password" "\"HwBZ]~@h\""
string | config/https_cert/renewal_data/S/ |
Item of renewal-method-specific data |
The value is subject to the following constraints: the value matches renewal methods[certificate renewal method].data_items[index of the value].regexp
Retrieving the value is denied if any of the following is true:
Changing the value is denied if any of the following is true:
Using the string as a field for indexing into the grandparent collection is denied if any of the following is true:
This string represents a value in persistent storage.
This string should be displayed in a secure manner if all of the following is true:
Sample curl
deletion command (note that :data_item
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_cert/renewal_data/:data_item/"
Sample uom
library write command (note that _data_item
is a variable):
uom.config.https_cert.renewal_data[_data_item]=""
call | config/https_cert/renew_cert/ |
Initiate attempt to renew the certificate using the selected method |
Performing the function call is denied if any of the following is true:
The call has no arguments (supply empty tuple).
The call returns the following results:
Sample requests
invocation:
requests.post('http://192.168.0.100/restapi/config/https_cert/renew_cert/',auth=auth,headers=headers,json={})
⇒
(no output)
Sample JS request
invocation:
request.post({url:"config/https_cert/renew_cert/",body:[]});
⇒
(no output)
constant null | config/https_cert/renew_cert/results: 1/ |
No additional information available |
This constant does not correspond to an actual resource.
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 key is unchanged |
Performing the function call is denied if any of the following is true:
The call has no arguments (supply empty tuple).
The call returns the following results:
Sample JS request
invocation:
request.post({url:"config/https_cert/generate_key/",body:[]});
⇒
(no output)
Sample requests
invocation:
requests.post('http://192.168.0.100/restapi/config/https_cert/generate_key/',auth=auth,headers=headers,json={})
⇒
(no output)
constant null | config/https_cert/generate_key/results: 1/ |
No additional information available |
This constant does not correspond to an actual resource.
map | config/https_cert/known_dn_oids/ |
Known distinguished name element object identifiers |
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 CLI read command:
uom get "config/https_cert/known_dn_oids"
⇒
Sample JS request
read command:
request.get({url:"config/https_cert/known_dn_oids/"},function(error,response,body) {console.log(body)});
⇒
string | config/https_cert/known_dn_oids/S/ |
Object identifier value |
Retrieving the value is denied if not administrative user
This string does not support direct modification.
Sample curl
read command (note that :oid
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/https_cert/known_dn_oids/:oid/"
⇒
"2.5.4.7"
Sample requests
read command (note that _oid
is a variable):
print(requests.get('http://192.168.0.100/restapi/config/https_cert/known_dn_oids/'+_oid+'/',auth=auth,headers=headers).json())
⇒
'2.5.4.23'
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 | Name |
regexp | Regular expression |
secret | Secret |
Sample uom
library read command (note that _renewal_method
and _data_item_properties
are variables):
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",regexp="^[1-9][0-9]*$",secret=false}
Sample requests
write command (note that _renewal_method
and _data_item_properties
are variables):
requests.put('http://192.168.0.100/restapi/config/https_cert/known_renewal_methods/'+_renewal_method+'/data_items/'+_data_item_properties+'/',auth=auth,headers=headers,json={'regexp': '^((]|[!#&\'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))| )+$', 'name': 'ACMEv1 contact URLs, whitespace-separated', 'secret': False})
string | config/https_cert/known_renewal_methods/S/data_items/S/name/ |
Data item name |
Retrieving the value is denied if not administrative user
This string is a part of a composite value which is modified as a whole.
This string does not support direct modification.
Sample uom
library read command (note that _renewal_method
and _data_item_properties
are variables):
print(uom.dump(uom.config.https_cert.known_renewal_methods[_renewal_method].data_items[_data_item_properties].name))
⇒
"ACMEv2 contact URLs, whitespace-separated"
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}/name"
⇒
"Username to authenticate as"
string | config/https_cert/known_renewal_methods/S/data_items/S/regexp/ |
Regular expression which the data item must match |
Retrieving the value is denied if not administrative user
This string is a part of a composite value which is modified as a whole.
This string does not support direct modification.
Sample curl
read command (note that :renewal_method
and :data_item_properties
are URL template 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/regexp/"
⇒
"^[1-9][0-9]*$"
Sample JS request
read command (note that _renewal_method
and _data_item_properties
are variables):
request.get({url:"config/https_cert/known_renewal_methods/"+_renewal_method+"/data_items/"+_data_item_properties+"/regexp/"},function(error,response,body) {console.log(body)});
⇒
"^((]|[!#&'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))| )+$"
sum (boolean) | config/https_cert/known_renewal_methods/S/data_items/S/secret/ |
Flag indicating whether the data item can contain private information |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
constant true | Secret | The data item can contain private information | |
constant false | Not secret | The data item contains only public information |
Sample JS request
read command (note that _renewal_method
and _data_item_properties
are variables):
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 requests
read command (note that _renewal_method
and _data_item_properties
are variables):
print(requests.get('http://192.168.0.100/restapi/config/https_cert/known_renewal_methods/'+_renewal_method+'/data_items/'+_data_item_properties+'/secret/',auth=auth,headers=headers).json())
⇒
False
object | config/https_cert/known_renewal_methods/S/ |
Method of certificate renewal |
Retrieving the value is denied if not administrative user
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
name | Name |
data_items | Supported data items |
Sample requests
read command (note that _renewal_method
is a variable):
print(requests.get('http://192.168.0.100/restapi/config/https_cert/known_renewal_methods/'+_renewal_method+'/',auth=auth,headers=headers).json())
⇒
{'name': 'Generate a self-signed certificate', 'data_items': {'days': {'regexp': '^[1-9][0-9]*$', 'name': 'Number of days to issue new certificates for', 'secret': False}}}
Sample CLI read command (note that renewal_method
is a variable):
uom get "config/https_cert/known_renewal_methods/${renewal_method}"
⇒
string | config/https_cert/known_renewal_methods/S/name/ |
Renewal method name |
Retrieving the value is denied if not administrative user
This string is a part of a composite value which is modified as a whole.
This string does not support direct modification.
Sample curl
read command (note that :renewal_method
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/https_cert/known_renewal_methods/:renewal_method/name/"
⇒
"Obtain a certificate from an ACME v1 endpoint (e.g. Let's Encrypt)"
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)"
map | config/https_cert/known_renewal_methods/S/data_items/ |
Properties of supported data items |
Retrieving the value is denied if not administrative user
This map is a part of a composite value which is modified as a whole.
This map does not support direct modification.
This map contains Data item properties elements.
Creating elements in this collection is not supported.
Sample curl
read command (note that :renewal_method
is a URL template argument):
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/"
⇒
{"days":{"regexp":"^[1-9][0-9]*$","name":"Number of days to issue new certificates for","secret":false}}
Sample JS request
read command (note that _renewal_method
is a variable):
request.get({url:"config/https_cert/known_renewal_methods/"+_renewal_method+"/data_items/"},function(error,response,body) {console.log(body)});
⇒
See also Supported data items: Data item properties
map | config/certificates/ |
Map of known certificates and their settings |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This map represents a value in persistent storage.
Changes to this map do not take effect immediately.
This map contains Certificate elements.
Sample curl
certificate creation command:
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"data\":\"-----BEGIN CERTIFICATE-----\\nMIIvO/JOECjWx6ErqrcE1k3RkKtCQvVpQIlqK5FaK+7H7N8+EnEIYJlIgfX6a2y0\\ntjr8KB9TVJtgJ8TZS1vELcvukVzjYMTS5LdRYpx38qlT/F3TI/kfdgaOBZ7mycE3\\nuXYjVetMQNNhSt/Udh7JHYXshKqKbwKVUuE/Y8N+Xnh0gjXJQgfjEDcyZTIAQeiw\\nyy87M8g9sjsbGC2ztnE6PCivXvLBdIncGxlf6Sr+BjcUxgTrUj+wxirUeDiHXVvq\\nhVb9McN6Ft3xMxS6xO4gGbKVJd2rZv=\\n-----END CERTIFICATE-----\\n\",\"status\":true}" "http://192.168.0.100/restapi/config/certificates/iTrustBazWard_Primary_Certification_Authority/"
Sample uom
library read command:
print(uom.dump(uom.config.certificates))
⇒
<...>
See also Certificate collection: Certificate
object | config/certificates/S/ |
Certificate settings |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This object represents a value in persistent storage.
Changes to this object do not take effect immediately.
This object contains the following items:
data | Data |
status | Trust status |
Sample JS request
write command (note that _certificate
is a variable):
request.put({url:"config/certificates/"+_certificate+"/",body:{"data":"-----BEGIN CERTIFICATE-----\nMIIagdL2nFNWMXW0fjyPwPOVGRbSEls3N2f3i07VIX2g5ajmKhCG7coP4PtKBmPa\nfZ8p5SMA9TnvG7cVQl8EBEg4aut0Vk8BJI0RnPdzvRuBaXj1JtIW7+dkvWnQGxdc\ng335j20AyEnVzqrs9=\n-----END CERTIFICATE-----\n","status":true}});
Sample CLI write command (note that certificate
is a variable):
uom set "config/certificates/${certificate}" "{\"data\":\"-----BEGIN CERTIFICATE-----\\nMII1hoRSrkxkWn7e+648roQ7RQp4nQqapNdXB502s+oOny2o59zzzP6QsyXfONFE\\noz0q2uqsIdrNSyZRxYs4/k2YQTxijjdXjfOnZEguuYIMXtqVRjbTUg1w9+evkHTU\\ntIY8/T3ZnR6hId91FeXyhU8i83TRZ+QTI/dJUiuIA1/VgBYyr6wZc4ImAnE==\\n-----END CERTIFICATE-----\\n\",\"status\":true}"
string | config/certificates/S/data/ |
Certificate data |
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:
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))
⇒
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 "\"-----BEGIN CERTIFICATE-----\\nMII2Cv9mTdhtPe0hsWBoBla5XoMrJqYHqEL29XrfAYYcDaK57XvKIWSsKrjghIzY\\ndjuUP52zjIa4PjdL4yuYrFPax7vwiTILDDrfKwe4FEAg+q24pzfgE5HBEC8yiTKy\\nCd39I9QZM6ZDBg3ALmQT3ejIpi1I2/0Hf5SzHuZg19wEr/RDnuitYSBOBEiFGlZx\\n1xAxWt+ipEZripecXYB0mbD0KVJ54H+7EA4n34VvL5m4wRiU/wXnXm==\\n-----END CERTIFICATE-----\\n\"" "http://192.168.0.100/restapi/config/certificates/:certificate/data/"
sum (boolean) | config/certificates/S/status/ |
Whether the certificate is trusted by default |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 default settings | |
constant false | Untrusted | The certificate is not trusted by all software with default settings |
Sample CLI read command (note that certificate
is a variable):
uom get "config/certificates/${certificate}/status"
⇒
true
Sample uom
library write command (note that _certificate
is a variable):
uom.config.certificates[_certificate].status=true
map | config/crls/ |
Map of known certificate revocation lists and their settings |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This map represents a value in persistent storage.
Changes to this map do not take effect immediately.
This map contains Certificate revocation list elements.
Sample requests
certificate revocation list creation command:
requests.put('http://192.168.0.100/restapi/config/crls/VeriFooProtect_Root_Certification_Authority/',auth=auth,headers=headers,json={'data': '-----BEGIN X509 CRL-----\nMII5Kjvh0mA6aq0B41oDCYDirtRF6XPUAwbXfXFiJRqwHt7Owyd9XtuOnLfwv5R5\nfjcxRxOIuiB2680mJZfDzSbfOWmrepwJYYH0WhLRQYVZiXL270I6VvnwRao5PlR+\nk1tSOKuyrThPrmZt4hP/VLT5AaXx2YHpbAH0XC+OiiqZUQTb8udfG6nTjLQnvkdX\nwZT9autJlSqByRLt41ADrfyC5m8rPioMIIXuDQE+v4CuXZnedztUesjmeue4cSSw\n/r0S50OCEIlq6QU5K+mCkZseDzHiRDVT4XyCaMQrhCipfCx/DkD+J6eZ5xIZBq2I\n0W+Pzr6Baytovu2g720GibNgwyum1CA4lBWk2eyedrTZmXFvbHCKvb1saxee9rkx\nGh7xgoaYHAKrRGTlVpg6sYjpDN/48y9RgION6/xQCIHfbnQ6c7FVh/KwPM1ZKC00\nRQgTO7hiRNKEpTsylNgmkdB6hnTwqWTIyAnMJV5muR0kxvjiIPV32jBmXhiNDBhB\nVZj0gVx8Xh5SQqnrMsw54ifnQ21emE2HpnJVJGft+nLQd9I02E89zpzQt05fGAz5\nIdJbJCb6a1mlMoqcy/cn+2h0ANJMMRMh4hIPvwYV+KHM87/79dxAieDu2YGQ/e76\nSYHP6pPS6odGpmSSkeAOt5T=\n-----END X509 CRL-----\n', 'status': 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 "..." "http://192.168.0.100/restapi/config/crls/"
See also Certificate revocation list collection: Certificate revocation list
object | config/crls/S/ |
Certificate revocation list settings |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This object represents a value in persistent storage.
Changes to this object do not take effect immediately.
This object contains the following items:
data | Data |
status | Usage status |
Sample CLI write command (note that certificate_revocation_list
is a variable):
uom set "config/crls/${certificate_revocation_list}" "{\"data\":\"-----BEGIN X509 CRL-----\\nMIIL9g2hUhbXIOiLBlDuVoeNKj6LdY1a5OxG40+bjc911tPFff9ATqZqZiBCHEpP\\nimoiNYLYbPS1g8jsLDix3IfGWzXMOC86+zrOYCzAdRDKcyCzCwwHEbanb79/MK7N\\n+nuDn4tEKDsJRsXOoqfQQT1ae2z/BMLCAGSzNLEja722/bTpS8FvdIVINVKbuiq4\\nI\\n-----END X509 CRL-----\\n\",\"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+'/',auth=auth,headers=headers,json={'data': '-----BEGIN X509 CRL-----\nMIINhwx9r8GpTKZ1v2V94xCYmQnktVBBPKa6GYH8jazCxZGsdn2klGJYi6IcdWp2\nB9/VJk6Jy3vFyY30JrJeP2mkgQGWV9ziL+EhkM0jSy/QX4SsxoWNsI7ZkQ6Gc5/z\nFhtekd7ie=\n-----END X509 CRL-----\n', 'status': False})
string | config/crls/S/data/ |
CRL data |
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:
This string represents a value in persistent storage.
Changes to this string do not take effect immediately.
Sample CLI read command (note that certificate_revocation_list
is a variable):
uom get "config/crls/${certificate_revocation_list}/data"
⇒
Sample uom
library write command (note that _certificate_revocation_list
is a variable):
uom.config.crls[_certificate_revocation_list].data="-----BEGIN X509 CRL-----\ MIIc4N7EaZAkg3opN/+FZqjLROo0cGG8aRngqwxQV7ACD/1c02ucudzM2nPg4hqg\ M/aKS5TfKigNKjRFLMuKly8AfEuWw3AJ5nfZu8FFtxeEh6V2UPPFOaS4qMdnSq6Z\ o8YyPpsNT64bd963bOUBsb2EErj4+IjoSHnu7fHcnOERaMXCn1PfeUwvLf/MzlAS\ +MCfgrT55xiUUwIXMzCsv7Db9bbwo30oSEU96+HEx/kSx30J2EB+ORbZ3CVuIYjm\ DywEFACGxgE0ia5zo5NGjyLyUGG2/3tE2qVJ1jc/Qt28T98IHXa1Wy/1EI6FO/WS\ 1ownRxDK/OqBY8V6kYejahzvqFKsookrdgf4euQfIGtsRP+CzfxaNxVDCr51gsvK\ aQCUtuoAohdDirDNppmmL0/D72w0+Gaajp5ckwoYdSoLK2l9tYyFa+Vk3Rm3kNfT\ m6zixYMPNkmRVxL\ -----END X509 CRL-----\ "
sum (boolean) | config/crls/S/status/ |
Whether the certificate revocation list is used by default |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 software with default settings | |
constant false | Unused | The certificate revocation list is not used by all software with default settings |
Sample CLI read command (note that certificate_revocation_list
is a variable):
uom get "config/crls/${certificate_revocation_list}/status"
⇒
true
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+'/status/',auth=auth,headers=headers).json())
⇒
True
sum (boolean) | config/ssh_enabled/ |
Whether the SSH server should be enabled |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 enabled | |
constant false | Disabled | The feature is disabled |
Sample JS request
read command:
request.get({url:"config/ssh_enabled/"},function(error,response,body) {console.log(body)});
⇒
false
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/config/ssh_enabled/',auth=auth,headers=headers,json=True)
number | config/ssh_port/ |
Port number of the SSH server |
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This number represents a value in persistent storage.
Changes to this number do not take effect immediately.
Sample CLI read command:
uom get "config/ssh_port"
⇒
22
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/ssh_port/',auth=auth,headers=headers).json())
⇒
22
array | config/ssh_authorized_keys/ |
List of public keys allowed to log in |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 uom
library SSH authorized key creation command:
local composite=uom.copy(uom.config.ssh_authorized_keys) uom.insert(composite,3,{comment="mas-",data="ssh-rsa 0Uq=",options=""}) uom.config.ssh_authorized_keys=composite
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': 'ssh-rsa uO7QM=', 'options': 'd=9,dmzlrso', 'comment': 'yxe'})
See also SSH authorized keys: SSH authorized key
object | config/ssh_authorized_keys/N/ |
Public key allowed to log in |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 | Data |
options | Options |
comment | Comment |
Sample curl
deletion command (note that :ssh_authorized_key_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/ssh_authorized_keys/:ssh_authorized_key_index/"
Sample uom
library write command (note that _ssh_authorized_key_index
is a variable):
uom.config.ssh_authorized_keys[_ssh_authorized_key_index]={comment="xm",data="ecdsa-sha2-nistp384 5PUe===",options=""}
string | config/ssh_authorized_keys/N/data/ |
Public key data |
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:
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 CLI write command (note that ssh_authorized_key_index
is a variable):
uom set "config/ssh_authorized_keys/${ssh_authorized_key_index}/data" "\"ssh-dss mZ4\""
Sample requests
write command (note that _ssh_authorized_key_index
is a variable):
requests.put('http://192.168.0.100/restapi/config/ssh_authorized_keys/'+str(_ssh_authorized_key_index)+'/data/',auth=auth,headers=headers,json='ssh-dss We=')
string | config/ssh_authorized_keys/N/options/ |
Public key options |
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:
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 uom
library write command (note that _ssh_authorized_key_index
is a variable):
uom.config.ssh_authorized_keys[_ssh_authorized_key_index].options=""
Sample curl
write command (note that :ssh_authorized_key_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 "\"\"" "http://192.168.0.100/restapi/config/ssh_authorized_keys/:ssh_authorized_key_index/options/"
string | config/ssh_authorized_keys/N/comment/ |
Public key comment |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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):
print(requests.get('http://192.168.0.100/restapi/config/ssh_authorized_keys/'+str(_ssh_authorized_key_index)+'/comment/',auth=auth,headers=headers).json())
⇒
'u'
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/"
⇒
""
sum (boolean) | config/ntp_server_enabled/ |
Whether the device should act as NTP server |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 enabled | |
constant false | Disabled | The feature is disabled |
Sample JS request
read command:
request.get({url:"config/ntp_server_enabled/"},function(error,response,body) {console.log(body)});
⇒
true
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/ntp_server_enabled/',auth=auth,headers=headers).json())
⇒
False
array | config/ntp_peers/ |
List of NTP servers to get time information from |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This array represents a value in persistent storage.
Changes to this array do not take effect immediately.
This array contains NTP peer elements.
Sample requests
NTP peer creation command:
requests.post('http://192.168.0.100/restapi/config/ntp_peers/',auth=auth,headers=headers,json='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/"
sum (string) | config/ntp_peers/N/ |
NTP server to get time information from |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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])$ |
Sample CLI write command (note that ntp_peer_index
is a variable):
uom set "config/ntp_peers/${ntp_peer_index}" "\"2.ntp-pool.example.com\""
Sample curl
write command (note that :ntp_peer_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.ntp-pool.example.com\"" "http://192.168.0.100/restapi/config/ntp_peers/:ntp_peer_index/"
sum (enumerated number) | config/syslog_minimal_severity/ |
Threshold severity for system messages, below which they are not logged |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 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 requests
write command:
requests.put('http://192.168.0.100/restapi/config/syslog_minimal_severity/',auth=auth,headers=headers,json=8)
Sample JS request
read command:
request.get({url:"config/syslog_minimal_severity/"},function(error,response,body) {console.log(body)});
⇒
8
sum (optional string) | config/syslog_ip_address/ |
Host name or IPv4 address of the syslog server to forward log messages to, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 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 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])$ |
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 uom
library read command:
print(uom.dump(uom.config.syslog_ip_address))
⇒
null
sum (boolean) | config/allow_jsonrpc/ |
Enable HTTP clients to perform JSON-RPC requests |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample JS request
write command:
request.put({url:"config/allow_jsonrpc/",body:false});
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/config/allow_jsonrpc/',auth=auth,headers=headers,json=True)
sum (boolean) | config/allow_jsonrpc_nonadmin/ |
Enable JSON-RPC API requests from users which are not administrators |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample uom
library write command:
uom.config.allow_jsonrpc_nonadmin=false
Sample JS request
write command:
request.put({url:"config/allow_jsonrpc_nonadmin/",body:true});
sum (boolean) | config/allow_restapi/ |
Enable HTTP clients to perform REST-like API requests |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/config/allow_restapi/',auth=auth,headers=headers,json=True)
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/allow_restapi/',auth=auth,headers=headers).json())
⇒
True
sum (boolean) | config/allow_restapi_nonadmin/ |
Enable REST-like API requests from users which are not administrators |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample CLI read command:
uom get "config/allow_restapi_nonadmin"
⇒
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_nonadmin/"
array | config/allow_restapi_origins/ |
List of origins permitted to access the REST-like API |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This array represents a value in persistent storage.
This array contains Allowed REST-like API client origin elements.
Sample curl
allowed REST-like API 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://bar.example.com\"" "http://192.168.0.100/restapi/config/allow_restapi_origins/"
Sample CLI read command:
uom get "config/allow_restapi_origins"
⇒
["https://bar.example.com"]
string | config/allow_restapi_origins/N/ |
Origin permitted to access the REST-like API |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample CLI write command (note that allowed_rest_like_api_client_origin_index
is a variable):
uom set "config/allow_restapi_origins/${allowed_rest_like_api_client_origin_index}" "\"http://foo.example.com:8042\""
Sample JS request
deletion command (note that _allowed_rest_like_api_client_origin_index
is a variable):
request.delete({url:"config/allow_restapi_origins/"+_allowed_rest_like_api_client_origin_index.toString()+"/"});
sum (boolean) | config/allow_coapws/ |
Enable HTTP clients to establish CoAP over WebSockets connections |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant 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/allow_coapws/"
⇒
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_coapws/"
sum (boolean) | config/allow_coapws_nonadmin/ |
Enable CoAP over WebSockets connections from users which are not administrators |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample CLI read command:
uom get "config/allow_coapws_nonadmin"
⇒
false
Sample uom
library write command:
uom.config.allow_coapws_nonadmin=true
array | config/allow_coapws_origins/ |
List of origins permitted to access CoAP over WebSockets |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This array represents a value in persistent storage.
This array contains Allowed CoAP over WebSockets client origin elements.
Sample CLI read command:
uom get "config/allow_coapws_origins"
⇒
["https://foo.example.com:18443","https://bar.example.com:18443","https://foo.example.com:8443"]
Sample CLI write command:
uom set "config/allow_coapws_origins" "[\"http://foo.example.com:8006\",\"https://foo.example.com:8443\"]"
string | config/allow_coapws_origins/N/ |
Origin permitted to access CoAP over WebSockets |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample CLI deletion command (note that allowed_coap_over_websockets_client_origin_index
is a variable):
uom remove "config/allow_coapws_origins/${allowed_coap_over_websockets_client_origin_index}"
Sample CLI write command (note that allowed_coap_over_websockets_client_origin_index
is a variable):
uom set "config/allow_coapws_origins/${allowed_coap_over_websockets_client_origin_index}" "\"https://bar.example.com:8443\""
sum (boolean) | config/relax_nonhtml_methods/ |
Enable HTTP clients to perform PUT/PATCH/DELETE API requests without a CSRF protection header (currently cannot be sent via an HTML form) |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample uom
library read command:
print(uom.dump(uom.config.relax_nonhtml_methods))
⇒
true
Sample CLI write command:
uom set "config/relax_nonhtml_methods" "false"
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 CSRF protection header (currently cannot be sent via an HTML form) |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/config/relax_nonhtml_content_types/',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/config/relax_nonhtml_content_types/"
⇒
false
sum (boolean) | config/allow_plaintext_logins/ |
Allow HTTP clients to authenticate using Basic authentication or plaintext login form |
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 enabled | |
constant false | Disabled | The feature is disabled |
Sample uom
library write command:
uom.config.allow_plaintext_logins=true
Sample JS request
write command:
request.put({url:"config/allow_plaintext_logins/",body:false});
sum (boolean) | config/allow_modifying_get/ |
Allow HTTP clients to use GET web UI requests for changing state |
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 enabled | |
constant false | Disabled | The feature is disabled |
Sample CLI write command:
uom set "config/allow_modifying_get" "false"
Sample uom
library read command:
print(uom.dump(uom.config.allow_modifying_get))
⇒
true
sum (boolean) | config/name_always_visible/ |
Flag enabling visibility of relay name |
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 login page | |
constant false | Authorized users only | Relay name visible only on pages which require authorization |
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/"
sum (boolean) | config/hide_passwords/ |
Whether user passwords should be hidden |
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 CLI write command:
uom set "config/hide_passwords" "true"
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/hide_passwords/"
⇒
true
sum (boolean) | config/hide_wifi_key/ |
Whether the WiFi key should be hidden |
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 CLI write command:
uom set "config/hide_wifi_key" "true"
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/config/hide_wifi_key/',auth=auth,headers=headers,json=True)
number | config/lockout_delay_minutes/ |
Time during which, after several unsuccessful logins, subsequent logins are denied |
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
read command:
print(requests.get('http://192.168.0.100/restapi/config/lockout_delay_minutes/',auth=auth,headers=headers).json())
⇒
60
Sample uom
library read command:
print(uom.dump(uom.config.lockout_delay_minutes))
⇒
60
sum (boolean) | config/protect_firmware/ |
Protect firmware from being overwritten |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 uom
library write command:
uom.config.protect_firmware=true
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/protect_firmware/',auth=auth,headers=headers).json())
⇒
True
sum (boolean) | config/protect_admin/ |
Protect admin settings from being modified |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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_admin/"
Sample uom
library write command:
uom.config.protect_admin=false
sum (boolean) | config/protect_network/ |
Protect network settings from being modified |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 write command:
uom set "config/protect_network" "true"
Sample uom
library write command:
uom.config.protect_network=false
sum (boolean) | config/protect_private_config/ |
Protect private configuration settings from being stored in backups |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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
read command:
print(requests.get('http://192.168.0.100/restapi/config/protect_private_config/',auth=auth,headers=headers).json())
⇒
False
Sample JS request
write command:
request.put({url:"config/protect_private_config/",body:false});
sum (boolean) | config/protect_restore/ |
Protect settings from being restored from backups |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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_restore"
⇒
true
Sample JS request
write command:
request.put({url:"config/protect_restore/",body:true});
sum (boolean) | config/protect_maintenance/ |
Disable remote maintenance support |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
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 write command:
uom set "config/protect_maintenance" "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/protect_maintenance/"
sum (variant) | config/protect_notification/ |
Protect notification settings from being modified |
Retrieving the value is denied if all of the following is true:
Changing the value is denied if any of the following is true:
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 related to sender configuration can still be read and changed |
Sample JS request
write command:
request.put({url:"config/protect_notification/",body:false});
Sample uom
library read command:
print(uom.dump(uom.config.protect_notification))
⇒
false
sum (boolean) | config/upgrade_notify_beep/ |
Indicate firmware upgrade progress by beeping |
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 enabled | |
constant false | Disabled | The feature is disabled |
Sample JS request
write command:
request.put({url:"config/upgrade_notify_beep/",body:true});
Sample CLI read command:
uom get "config/upgrade_notify_beep"
⇒
false
sum (boolean) | config/upgrade_notify_blink/ |
Indicate firmware upgrade progress by blinking |
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 enabled | |
constant false | Disabled | The feature is disabled |
Sample uom
library read command:
print(uom.dump(uom.config.upgrade_notify_blink))
⇒
true
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/config/upgrade_notify_blink/',auth=auth,headers=headers,json=False)
map | config/known_quantities/ |
Map of known physical quantities |
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 uom
library read command:
print(uom.dump(uom.config.known_quantities))
⇒
<...>
Sample CLI read command:
uom get "config/known_quantities"
⇒
...
object | config/known_quantities/S/ |
Physical quantity |
This object contains the following items:
name | Name |
units | Known units |
preferred_unit | Preferred unit, if any |
Sample CLI write command (note that quantity
is a variable):
uom set "config/known_quantities/${quantity}" "{\"preferred_unit\":null,\"name\":\"Illuminance\",\"units\":{\"lx\":{\"offset\":0,\"name\":\"lux\",\"scale\":1},\"fc\":{\"offset\":0,\"internal\":false,\"name\":\"foot-candle\",\"scale\":0.09290226681531}}}"
Sample uom
library write command (note that _quantity
is a variable):
uom.config.known_quantities[_quantity]={name="Time",preferred_unit="s",units={s={name="second",offset=0,scale=1}}}
See also Quantity: Name
See also Quantity: Known units
See also Quantity: Preferred unit, if any
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"
⇒
"Time"
Sample uom
library read command (note that _quantity
is a variable):
print(uom.dump(uom.config.known_quantities[_quantity].name))
⇒
"Voltage"
map | config/known_quantities/S/units/ |
Map of known units for quantity |
Changing the value is denied if not administrative user
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 curl
read command (note that :quantity
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/known_quantities/:quantity/units/"
⇒
{"V":{"offset":0,"internal":true,"name":"volt","scale":1}}
Sample CLI unit creation command (note that quantity
is a variable):
uom insert "config/known_quantities/${quantity}/units/s" "{\"offset\":0,\"internal\":false,\"name\":\"second\",\"scale\":1}"
object | config/known_quantities/S/units/S/ |
Unit of physical quantity |
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 | Name |
scale | Scaling factor |
offset | Offset |
internal | Internal |
Sample curl
deletion command (note that :quantity
and :unit
are URL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X DELETE -H "Accept: application/json" "http://192.168.0.100/restapi/config/known_quantities/:quantity/units/:unit/"
Sample uom
library read command (note that _quantity
and _unit
are variables):
print(uom.dump(uom.config.known_quantities[_quantity].units[_unit]))
⇒
{internal=true,name="kilowatt-hour",offset=0,scale=2.77777778e-07}
string | config/known_quantities/S/units/S/name/ |
Unit name |
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 write command (note that quantity
and unit
are variables):
uom set "config/known_quantities/${quantity}/units/${unit}/name" "\"\""
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/name/"
⇒
"second"
number | config/known_quantities/S/units/S/scale/ |
Scaling factor for conversion from standard SI unit |
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
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/scale/"
⇒
1
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+'/scale/',auth=auth,headers=headers,json=100)
number | config/known_quantities/S/units/S/offset/ |
Offset for conversion from standard SI unit |
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
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/offset/"
⇒
-459.67
Sample JS request
read command (note that _quantity
and _unit
are variables):
request.get({url:"config/known_quantities/"+_quantity+"/units/"+_unit+"/offset/"},function(error,response,body) {console.log(body)});
⇒
-273.16
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 modified | |
constant false | User | This unit is user-supplied and can be modified |
Sample CLI read command (note that quantity
and unit
are variables):
uom get "config/known_quantities/${quantity}/units/${unit}/internal"
⇒
true
Sample JS request
read command (note that _quantity
and _unit
are variables):
request.get({url:"config/known_quantities/"+_quantity+"/units/"+_unit+"/internal/"},function(error,response,body) {console.log(body)});
⇒
true
sum (optional string) | config/known_quantities/S/preferred_unit/ |
Default UI unit for quantity, if any |
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 uom
library read command (note that _quantity
is a variable):
print(uom.dump(uom.config.known_quantities[_quantity].preferred_unit))
⇒
"px"
Sample CLI write command (note that quantity
is a variable):
uom set "config/known_quantities/${quantity}/preferred_unit" "\"V\""
map | config/known_timezones/ |
Map of known time zones |
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 requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/known_timezones/',auth=auth,headers=headers).json())
⇒
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/known_timezones/"
⇒
string | config/known_timezones/S/ |
Time zone name |
Retrieving the value is denied if not administrative user
This string is a part of a composite value which is modified as a whole.
This string does not support direct modification.
This string represents a value in persistent storage.
Sample JS request
read command (note that _timezone
is a variable):
request.get({url:"config/known_timezones/"+_timezone+"/"},function(error,response,body) {console.log(body)});
⇒
"UTC-2"
Sample CLI read command (note that timezone
is a variable):
uom get "config/known_timezones/${timezone}"
⇒
"UTC-3"
map | config/known_protection_bits/ |
Map of known protection bits |
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 CLI read command:
uom get "config/known_protection_bits"
⇒
See also Known protection bits: Protection bit
object | config/known_protection_bits/S/ |
Protection bit properties |
Retrieving the value is denied if not administrative user
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
name | Name |
status | Protection status |
Sample JS request
read command (note that _protection_bit
is a variable):
request.get({url:"config/known_protection_bits/"+_protection_bit+"/"},function(error,response,body) {console.log(body)});
⇒
{"name":"Firmware protection","status":false}
Sample CLI read command (note that protection_bit
is a variable):
uom get "config/known_protection_bits/${protection_bit}"
⇒
{"name":"Network settings protection","status":"You have enabled that and that service which allows to bypass this protection"}
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 uom
library read command (note that _protection_bit
is a variable):
print(uom.dump(uom.config.known_protection_bits[_protection_bit].name))
⇒
"Notification settings protection"
Sample curl
read command (note that :protection_bit
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/known_protection_bits/:protection_bit/name/"
⇒
"Network settings protection"
sum (variant) | config/known_protection_bits/S/status/ |
Status of protection |
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 | Enabled | Protection is enabled and effective | |
constant false | Disabled | Protection is disabled | |
string | Ineffective | Protection is enabled, but not effective for the following reason |
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+'/status/',auth=auth,headers=headers).json())
⇒
'You have enabled that and that service which allows to bypass this protection'
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)});
⇒
true
array | config/relay_ports/ |
List of devices to which relay modules are connected |
Retrieving the value is denied if not administrative user
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 curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/relay_ports/"
⇒
["ttyATH0"]
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/config/relay_ports/',auth=auth,headers=headers).json())
⇒
['ttyATH0']
string | config/relay_ports/N/ |
Filename of a relay module device |
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
This string is expected to be visible to advanced users only.
Sample curl
read command (note that :relay_port_index
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/relay_ports/:relay_port_index/"
⇒
"ttyATH0"
Sample CLI read command (note that relay_port_index
is a variable):
uom get "config/relay_ports/${relay_port_index}"
⇒
"ttyATH0"