DLI DC3 Object Model Reference
20210819T152642Z
Configuration server object
objectconfig/
Object representing configuration server
dot_inline_dotgraph_143.png

This object contains the following items:

linksLinks list
plotsPlots list
metersMeters list
contactPrimary unit contact
contactsRelated contacts
locationUnit location
oidModel OID
versionVersion number
hardware_idHardware ID
serialSerial number
outlet_labelOutlet label
brand_company_nameBrand company name
brand_nameBrand name
brand_urlBrand URL
brand_manual_urlBrand manual URL
brand_faq_urlBrand FAQ URL
brand_product_info_urlBrand product information URL
support_emailSupport email
register_urlRegistration URL
support_urlSupport URL
update_urlUpdate URL
custom_brand_company_nameCustom brand company name, if any
custom_brand_nameCustom brand name, if any
custom_brand_urlCustom brand URL, if any
custom_brand_logoCustom brand logo URL, if any
custom_brand_logo_widthCustom brand logo width, if any
custom_brand_logo_heightCustom brand logo height, if any
custom_support_emailCustom support email, if any
custom_register_urlCustom registration URL, if any
custom_support_urlCustom support URL, if any
custom_update_urlCustom update URL, if any
custom_help_urlCustom help URL, if any
customization_statusCustomization status
registration_statusRegistration status
refresh_enabledEnable page refresh
refresh_delay_minutesPage refresh delay
image_formatPreferred image format
hostnameUnit hostname
timezoneTime zone
http_portsHTTP ports
https_portsHTTPS ports
https_certHTTPS certificate settings
certificatesCertificate collection
crlsCertificate revocation list collection
ssh_enabledSSH enabled
ssh_portSSH port number
ssh_authorized_keysSSH authorized keys
ntp_server_enabledNTP server enabled
ntp_peersNTP peers
syslog_minimal_severitySyslog threshold severity
syslog_ip_addressSyslog server address, if any
allow_jsonrpcAllow JSON-RPC
allow_jsonrpc_nonadminAllow non-administrative users to perform JSON-RPC requests
allow_restapiAllow REST-like API
allow_restapi_nonadminAllow non-administrative users to access REST-like API
allow_restapi_originsAllowed REST-like API client origins
allow_coapwsAllow CoAP over WebSockets
allow_coapws_nonadminAllow non-administrative users to access CoAP over WebSockets
allow_coapws_originsAllowed CoAP over WebSockets client origins
relax_nonhtml_methodsRelax non-HTML method CSRF checks
relax_nonhtml_content_typesRelax non-HTML content type CSRF checks
allow_plaintext_loginsAllow plaintext logins
allow_plaintext_url_loginsAllow plaintext URL logins
allow_modifying_getAllow state-changing GET requests
name_always_visibleRelay name visibility
hide_passwordsHide user passwords
hide_wifi_keyHide WiFi key
lockout_delay_minutesSecurity lockout duration
protect_firmwareProtect firmware
protect_adminProtect admin login
protect_networkProtect network settings
protect_private_configProtect private settings
protect_restoreProtect from restore
protect_maintenanceProtect from maintenance
protect_notificationProtect notification settings
upgrade_notify_beepBeep on upgrade
upgrade_notify_blinkBlink on upgrade
known_quantitiesKnown quantities
known_timezonesKnown timezones
known_protection_bitsKnown protection bits
relay_portsRelay ports

Sample JS request write command:

request.put({url:"config/",body:<...>});

Sample requests read command:

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

<...>

Browse more samples

Links list

arrayconfig/links/
List of user-defined links to display in the web UI
dot_inline_dotgraph_144.png

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 requests read command:

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

[{'description': 'test 5', 'href': 'test_url7'}, {'description': 'test 3', 'href': 'test_url5'}]

Sample CLI link creation command:

uom insert "config/links/0" "{\"description\":\"test 5\",\"href\":\"test_url7\"}"

Browse more samples

See also Links list: Link

Links list: Link

objectconfig/links/N/
User-defined link
dot_inline_dotgraph_145.png

Retrieving the value is denied if not administrative user

This object represents a value in persistent storage.

This object contains the following items:

hrefURI
descriptionDescription

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/links/:link_index/"

{"description":"test 5","href":"test_url7"}

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

uom.config.links[_link_index]={description="test 3",href="test_url5"}

Browse more samples

URI

stringconfig/links/N/href/
The target URI of the link
dot_inline_dotgraph_146.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

uom set "config/links/${link_index}/href" "\"test_url7\""

Sample requests write command (note that _link_index is a variable):

requests.put('http://192.168.0.100/restapi/config/links/'+str(_link_index)+'/href/',auth=auth,headers=headers,json='test_url5')

Browse more samples

Description

stringconfig/links/N/description/
The textual representation of the link
dot_inline_dotgraph_147.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

request.put({url:"config/links/"+_link_index.toString()+"/description/",body:"test 5"});

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

uom set "config/links/${link_index}/description" "\"test 5\""

Browse more samples

Plots list

arrayconfig/plots/
List of plots to display in the web UI
dot_inline_dotgraph_148.png

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 requests read command:

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

<...>

Sample uom library plot creation command:

uom.insert(uom.config.plots,2,{data={{ds="buses.1.voltage",style={axes="x1y1",color="FF0000",marker="plus",size=0,style="lines",type="solid",width=1},title="Bus B voltage"},{ds="buses.1.current",style={axes="x1y2",color="0000FF",marker="plus",size=0,style="lines",type="solid",width=1},title="Bus B current"}},display=false,height=480,title="Bus B status",width=640,x1={max=null,min=null,mtics=null,softmax=null,softmin=null,tics=null},x2={max=null,min=null,mtics=null,softmax=null,softmin=null,tics=null},y1={max=null,min=0,mtics=null,softmax=110,softmin=null,tics=null},y2={max=null,min=0,mtics=null,softmax=1,softmin=null,tics=null}})

Browse more samples

Plot

objectconfig/plots/N/
Configuration of plot for measured values
dot_inline_dotgraph_149.png

This object contains the following items:

titleTitle
displayDisplay
widthWidth
heightHeight
x1X1 axis settings
x2X2 axis settings
y1Y1 axis settings
y2Y2 axis settings
dataPlot lines

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

Sample requests write command (note that _plot_index is a variable):

requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/',auth=auth,headers=headers,json={'x2': {'min': None, 'softmax': None, 'max': None, 'tics': None, 'mtics': None, 'softmin': None}, 'y2': {'min': None, 'softmax': None, 'max': None, 'tics': None, 'mtics': None, 'softmin': None}, 'data': [{'ds': 'battery_voltage', 'style': {'type': 'solid', 'style': 'lines', 'width': 1, 'color': 'FF0000', 'axes': 'x1y1', 'marker': 'plus', 'size': 0}, 'title': 'Battery voltage'}], 'width': 640, 'title': 'Battery voltage', 'display': False, 'y1': {'min': 0, 'softmax': None, 'max': None, 'tics': None, 'mtics': None, 'softmin': None}, 'x1': {'min': None, 'softmax': None, 'max': None, 'tics': None, 'mtics': None, 'softmin': None}, 'height': 480})

Browse more samples

See also Plot: Title

See also Plot: Display

See also Plot: Width

See also Plot: Height

See also Plot: X1 axis settings

See also Plot: X2 axis settings

See also Plot: Y1 axis settings

See also Plot: Y2 axis settings

See also Plot: Plot lines

Plot: Title

stringconfig/plots/N/title/
The title of the plot
dot_inline_dotgraph_150.png

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

'Illuminance'

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

uom get "config/plots/${plot_index}/title"

"Relay voltage"

Browse more samples

Plot: Display

sum (boolean)config/plots/N/display/
Indicates whether the plot should be displayed
dot_inline_dotgraph_151.png

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 trueShownThe plot is shown
constant falseHiddenThe plot is hidden

Sample requests write command (note that _plot_index is a variable):

requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/display/',auth=auth,headers=headers,json=False)

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

uom.config.plots[_plot_index].display=true

Browse more samples

Plot: Width

numberconfig/plots/N/width/
The width of the plot
dot_inline_dotgraph_152.png

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

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

Browse more samples

Plot: Height

numberconfig/plots/N/height/
The height of the plot
dot_inline_dotgraph_153.png

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 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 "480" "http://192.168.0.100/restapi/config/plots/:plot_index/height/"

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

uom set "config/plots/${plot_index}/height" "480"

Browse more samples

Plot: X1 axis settings

objectconfig/plots/N/x1/
Configuration for X1 axis
dot_inline_dotgraph_154.png

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:

minMinimum, if any
maxMaximum, if any
softminSoft minimum, if any
softmaxSoft maximum, if any
ticsMajor tick interval, if any
mticsMinor 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 uom library read command (note that _plot_index is a variable):

print(uom.dump(uom.config.plots[_plot_index].x1))

{max=null,min=null,mtics=null,softmax=null,softmin=null,tics=null}

Browse more samples

Minimum, if any

sum (optional number)config/plots/N/x1/min/
Minimum value to display on the axis, if any
dot_inline_dotgraph_155.png

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 nullAutomaticThe maximum value is derived from data and the soft maximum
numberMinimumMinimum value to display on the axis

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

uom.config.plots[_plot_index].x1.min=null

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

request.put({url:"config/plots/"+_plot_index.toString()+"/x1/min/",body:null});

Browse more samples

Maximum, if any

sum (optional number)config/plots/N/x1/max/
Maximum value to display on the axis, if any
dot_inline_dotgraph_156.png

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 nullAutomaticThe minimum value is derived from data and the soft minimum
numberMaximumMaximum 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

Browse more samples

Soft minimum, if any

sum (optional number)config/plots/N/x1/softmin/
Minimum value to display on the axis unless values exist below it, if any
dot_inline_dotgraph_157.png

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 nullNoneNo soft maximum defined
numberSoft minimumMinimum value to display on the axis unless values exist below 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/x1/softmin/"

null

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

uom.config.plots[_plot_index].x1.softmin=null

Browse more samples

Soft maximum, if any

sum (optional number)config/plots/N/x1/softmax/
Maximum value to display on the axis unless values exist above it, if any
dot_inline_dotgraph_158.png

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 nullNoneNo soft minimum defined
numberSoft maximumMaximum value to display on the axis unless values exist above it

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

uom.config.plots[_plot_index].x1.softmax=null

Sample requests write command (note that _plot_index is a variable):

requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/x1/softmax/',auth=auth,headers=headers,json=None)

Browse more samples

Major tick interval, if any

sum (optional number)config/plots/N/x1/tics/
The interval, in value units, between major ticks of the axis, if any
dot_inline_dotgraph_159.png

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 nullAutomaticThe tick interval is derived from data and size
numberMajor tick intervalThe interval, in value units, between major ticks of the axis

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

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "null" "http://192.168.0.100/restapi/config/plots/:plot_index/x1/tics/"

Sample 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

Browse more samples

Minor ticks per major tick, if any

sum (optional number)config/plots/N/x1/mtics/
The number of minor ticks between two major ticks, if any
dot_inline_dotgraph_160.png

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 nullNoneThere are no minor ticks
numberMinor ticks per major tickThe number of minor ticks between two major ticks

all of the following is true:

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

print(uom.dump(uom.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});

Browse more samples

Plot: X2 axis settings

objectconfig/plots/N/x2/
Configuration for X2 axis
dot_inline_dotgraph_161.png

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:

minMinimum, if any
maxMaximum, if any
softminSoft minimum, if any
softmaxSoft maximum, if any
ticsMajor tick interval, if any
mticsMinor ticks per major tick, if any

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

uom set "config/plots/${plot_index}/x2" "{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null}"

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

print(uom.dump(uom.config.plots[_plot_index].x2))

{max=null,min=null,mtics=null,softmax=null,softmin=null,tics=null}

Browse more samples

Minimum, if any

sum (optional number)config/plots/N/x2/min/
Minimum value to display on the axis, if any
dot_inline_dotgraph_162.png

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 nullAutomaticThe maximum value is derived from data and the soft maximum
numberMinimumMinimum 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()+"/x2/min/"},function(error,response,body) {console.log(body)});

null

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

print(uom.dump(uom.config.plots[_plot_index].x2.min))

null

Browse more samples

Maximum, if any

sum (optional number)config/plots/N/x2/max/
Maximum value to display on the axis, if any
dot_inline_dotgraph_163.png

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 nullAutomaticThe minimum value is derived from data and the soft minimum
numberMaximumMaximum value to display on the axis

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

uom set "config/plots/${plot_index}/x2/max" "null"

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

request.put({url:"config/plots/"+_plot_index.toString()+"/x2/max/",body:null});

Browse more samples

Soft minimum, if any

sum (optional number)config/plots/N/x2/softmin/
Minimum value to display on the axis unless values exist below it, if any
dot_inline_dotgraph_164.png

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 nullNoneNo soft maximum defined
numberSoft minimumMinimum value to display on the axis unless values exist below it

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

uom set "config/plots/${plot_index}/x2/softmin" "null"

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

uom.config.plots[_plot_index].x2.softmin=null

Browse more samples

Soft maximum, if any

sum (optional number)config/plots/N/x2/softmax/
Maximum value to display on the axis unless values exist above it, if any
dot_inline_dotgraph_165.png

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 nullNoneNo soft minimum defined
numberSoft maximumMaximum value to display on the axis unless values exist above it

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

uom set "config/plots/${plot_index}/x2/softmax" "null"

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

uom get "config/plots/${plot_index}/x2/softmax"

null

Browse more samples

Major tick interval, if any

sum (optional number)config/plots/N/x2/tics/
The interval, in value units, between major ticks of the axis, if any
dot_inline_dotgraph_166.png

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 nullAutomaticThe tick interval is derived from data and size
numberMajor tick intervalThe interval, in value units, between major ticks of the axis

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

request.put({url:"config/plots/"+_plot_index.toString()+"/x2/tics/",body:null});

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

print(uom.dump(uom.config.plots[_plot_index].x2.tics))

null

Browse more samples

Minor ticks per major tick, if any

sum (optional number)config/plots/N/x2/mtics/
The number of minor ticks between two major ticks, if any
dot_inline_dotgraph_167.png

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 nullNoneThere are no minor ticks
numberMinor ticks per major tickThe 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/x2/mtics/"

null

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

uom set "config/plots/${plot_index}/x2/mtics" "null"

Browse more samples

Plot: Y1 axis settings

objectconfig/plots/N/y1/
Configuration for Y1 axis
dot_inline_dotgraph_168.png

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:

minMinimum, if any
maxMaximum, if any
softminSoft minimum, if any
softmaxSoft maximum, if any
ticsMajor tick interval, if any
mticsMinor ticks per major tick, if any

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\":0,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null}" "http://192.168.0.100/restapi/config/plots/:plot_index/y1/"

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,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null}

Browse more samples

Minimum, if any

sum (optional number)config/plots/N/y1/min/
Minimum value to display on the axis, if any
dot_inline_dotgraph_169.png

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 nullAutomaticThe maximum value is derived from data and the soft maximum
numberMinimumMinimum 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 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 "0" "http://192.168.0.100/restapi/config/plots/:plot_index/y1/min/"

Browse more samples

Maximum, if any

sum (optional number)config/plots/N/y1/max/
Maximum value to display on the axis, if any
dot_inline_dotgraph_170.png

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 nullAutomaticThe minimum value is derived from data and the soft minimum
numberMaximumMaximum 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 JS request read command (note that _plot_index is a variable):

request.get({url:"config/plots/"+_plot_index.toString()+"/y1/max/"},function(error,response,body) {console.log(body)});

null

Browse more samples

Soft minimum, if any

sum (optional number)config/plots/N/y1/softmin/
Minimum value to display on the axis unless values exist below it, if any
dot_inline_dotgraph_171.png

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 nullNoneNo soft maximum defined
numberSoft minimumMinimum 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}/y1/softmin"

null

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

request.get({url:"config/plots/"+_plot_index.toString()+"/y1/softmin/"},function(error,response,body) {console.log(body)});

null

Browse more samples

Soft maximum, if any

sum (optional number)config/plots/N/y1/softmax/
Maximum value to display on the axis unless values exist above it, if any
dot_inline_dotgraph_172.png

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 nullNoneNo soft minimum defined
numberSoft maximumMaximum value to display on the axis unless values exist above it

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

uom.config.plots[_plot_index].y1.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/y1/softmax/"

110

Browse more samples

Major tick interval, if any

sum (optional number)config/plots/N/y1/tics/
The interval, in value units, between major ticks of the axis, if any
dot_inline_dotgraph_173.png

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 nullAutomaticThe tick interval is derived from data and size
numberMajor tick intervalThe interval, in value units, between major ticks of the axis

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

request.get({url:"config/plots/"+_plot_index.toString()+"/y1/tics/"},function(error,response,body) {console.log(body)});

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

Browse more samples

Minor ticks per major tick, if any

sum (optional number)config/plots/N/y1/mtics/
The number of minor ticks between two major ticks, if any
dot_inline_dotgraph_174.png

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 nullNoneThere are no minor ticks
numberMinor ticks per major tickThe 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 read command (note that plot_index is a variable):

uom get "config/plots/${plot_index}/y1/mtics"

null

Browse more samples

Plot: Y2 axis settings

objectconfig/plots/N/y2/
Configuration for Y2 axis
dot_inline_dotgraph_175.png

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:

minMinimum, if any
maxMaximum, if any
softminSoft minimum, if any
softmaxSoft maximum, if any
ticsMajor tick interval, if any
mticsMinor ticks per major tick, if any

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

request.put({url:"config/plots/"+_plot_index.toString()+"/y2/",body:{"min":null,"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/y2/"

Browse more samples

Minimum, if any

sum (optional number)config/plots/N/y2/min/
Minimum value to display on the axis, if any
dot_inline_dotgraph_176.png

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 nullAutomaticThe maximum value is derived from data and the soft maximum
numberMinimumMinimum 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/y2/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/y2/min/"

Browse more samples

Maximum, if any

sum (optional number)config/plots/N/y2/max/
Maximum value to display on the axis, if any
dot_inline_dotgraph_177.png

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 nullAutomaticThe minimum value is derived from data and the soft minimum
numberMaximumMaximum 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/y2/max/"

null

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

print(requests.get('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/y2/max/',auth=auth,headers=headers).json())

None

Browse more samples

Soft minimum, if any

sum (optional number)config/plots/N/y2/softmin/
Minimum value to display on the axis unless values exist below it, if any
dot_inline_dotgraph_178.png

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 nullNoneNo soft maximum defined
numberSoft minimumMinimum value to display on the axis unless values exist below it

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

request.get({url:"config/plots/"+_plot_index.toString()+"/y2/softmin/"},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)+'/y2/softmin/',auth=auth,headers=headers).json())

None

Browse more samples

Soft maximum, if any

sum (optional number)config/plots/N/y2/softmax/
Maximum value to display on the axis unless values exist above it, if any
dot_inline_dotgraph_179.png

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 nullNoneNo soft minimum defined
numberSoft maximumMaximum value to display on the axis unless values exist above 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)+'/y2/softmax/',auth=auth,headers=headers,json=None)

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

uom set "config/plots/${plot_index}/y2/softmax" "null"

Browse more samples

Major tick interval, if any

sum (optional number)config/plots/N/y2/tics/
The interval, in value units, between major ticks of the axis, if any
dot_inline_dotgraph_180.png

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 nullAutomaticThe tick interval is derived from data and size
numberMajor tick intervalThe 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 CLI read command (note that plot_index is a variable):

uom get "config/plots/${plot_index}/y2/tics"

null

Browse more samples

Minor ticks per major tick, if any

sum (optional number)config/plots/N/y2/mtics/
The number of minor ticks between two major ticks, if any
dot_inline_dotgraph_181.png

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 nullNoneThere are no minor ticks
numberMinor ticks per major tickThe 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/y2/mtics/"

null

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

uom.config.plots[_plot_index].y2.mtics=null

Browse more samples

Plot line configuration: Style

objectconfig/plots/N/data/N/style/
Style of the plot line
dot_inline_dotgraph_182.png

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:

styleLine style
typeLine type
colorLine color
widthLine width
markerMarker type
sizeMarker size
axesBase axes

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/",body:{"type":"solid","style":"lines","width":1,"color":"FF0000","axes":"x1y1","marker":"plus","size":0}});

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

{'type': 'solid', 'style': 'lines', 'width': 1, 'color': '0000FF', 'axes': 'x1y1', 'marker': 'plus', 'size': 0}

Browse more samples

Line style

stringconfig/plots/N/data/N/style/style/
The style of the line
dot_inline_dotgraph_183.png

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

Browse more samples

Line type

stringconfig/plots/N/data/N/style/type/
The type of the line
dot_inline_dotgraph_184.png

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

'solid'

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"

Browse more samples

Line color

stringconfig/plots/N/data/N/style/color/
The color of the line
dot_inline_dotgraph_185.png

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 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.color="FF0000"

Sample JS request write command (note that _plot_index and _plot_line_configuration_index are variables):

request.put({url:"config/plots/"+_plot_index.toString()+"/data/"+_plot_line_configuration_index.toString()+"/style/color/",body:"0000FF"});

Browse more samples

Line width

numberconfig/plots/N/data/N/style/width/
The width of the line
dot_inline_dotgraph_186.png

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 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.width=1

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

1

Browse more samples

Marker type

stringconfig/plots/N/data/N/style/marker/
The type of the marker
dot_inline_dotgraph_187.png

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

"plus"

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

Browse more samples

Marker size

numberconfig/plots/N/data/N/style/size/
The size of the markers
dot_inline_dotgraph_188.png

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 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.size))

0

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

0

Browse more samples

Base axes

stringconfig/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
dot_inline_dotgraph_189.png

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

'x1y1'

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/axes/',auth=auth,headers=headers,json='x1y1')

Browse more samples

Plot: Plot lines

arrayconfig/plots/N/data/
Configurations of values to plot
dot_inline_dotgraph_190.png

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

This array contains Plot line configuration elements.

Sample uom library plot line configuration creation command (note that _plot_index is a variable):

local composite=uom.copy(uom.config.plots[_plot_index].data)
uom.insert(composite,1,{ds="environment.illuminance",style={axes="x1y1",color="FF0000",marker="plus",size=0,style="lines",type="solid",width=1},title="Illuminance"})
uom.config.plots[_plot_index].data=composite

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

print(uom.dump(uom.config.plots[_plot_index].data))

Browse more samples

Plot line configuration

objectconfig/plots/N/data/N/
Properties of a plot line
dot_inline_dotgraph_191.png

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

This object contains the following items:

dsData source
titleTitle
styleStyle

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()+"/",body:{"ds":"buses.1.voltage","style":{"type":"solid","style":"lines","width":1,"color":"FF0000","axes":"x1y1","marker":"plus","size":0},"title":"Bus B voltage"}});

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.current\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"0000FF\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size\":0},\"title\":\"Bus B current\"}"

Browse more samples

Data source

stringconfig/plots/N/data/N/ds/
Identifier of the data source to use
dot_inline_dotgraph_192.png

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 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.1.voltage"

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

"relay_voltage"

Browse more samples

Title

stringconfig/plots/N/data/N/title/
The title of the plot line
dot_inline_dotgraph_193.png

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 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 "\"Relay voltage\"" "http://192.168.0.100/restapi/config/plots/:plot_index/data/:plot_line_configuration_index/title/"

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}/title" "\"Illuminance\""

Browse more samples

See also Plot line configuration: Style

Meters list

arrayconfig/meters/
List of meters to display in the web UI
dot_inline_dotgraph_194.png

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 write command:

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

Sample JS request write command:

request.put({url:"config/meters/",body:<...>});

Browse more samples

Meter configuration

objectconfig/meters/N/
Configuration of meter for a measured value
dot_inline_dotgraph_195.png

This object contains the following items:

titleTitle
displayDisplay
dataData source
widthWidth
heightHeight
scaleDisplay scale
decimalsDecimals
colorArrow color
min_valueMinimum value
sectorsMeter sectors

Sample curl deletion command (note that :meter_configuration_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/meters/:meter_configuration_index/"

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

uom set "config/meters/${meter_configuration_index}" "{\"decimals\":0,\"color\":\"\",\"sectors\":[{\"color\":\"0000FF\",\"name\":\"Low\",\"value\":100},{\"color\":\"00FF00\",\"name\":\"Optimal\",\"value\":127},{\"color\":\"FF0000\",\"name\":\"High\",\"value\":140}],\"data\":\"buses.1.voltage\",\"width\":128,\"title\":\"Bus B voltage\",\"display\":true,\"min_value\":90,\"scale\":\"linear\",\"height\":64}"

Browse more samples

See also Meter configuration: Title

See also Meter configuration: Display

See also Meter configuration: Data source

See also Meter configuration: Width

See also Meter configuration: Height

See also Meter configuration: Display scale

See also Meter configuration: Decimals

See also Meter configuration: Arrow color

See also Meter configuration: Minimum value

See also Meter configuration: Meter sectors

Meter configuration: Title

stringconfig/meters/N/title/
The title of the meter
dot_inline_dotgraph_196.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

uom get "config/meters/${meter_configuration_index}/title"

"Illuminance"

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

print(uom.dump(uom.config.meters[_meter_configuration_index].title))

"Bus B voltage"

Browse more samples

Meter configuration: Display

sum (boolean)config/meters/N/display/
Indicates whether the meter should be displayed
dot_inline_dotgraph_197.png

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 trueShownThe meter is shown
constant falseHiddenThe meter is hidden

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

False

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/meters/:meter_configuration_index/display/"

true

Browse more samples

Meter configuration: Data source

stringconfig/meters/N/data/
Identifier of the data source to use
dot_inline_dotgraph_198.png

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

print(uom.dump(uom.config.meters[_meter_configuration_index].data))

"battery_voltage"

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='battery_voltage')

Browse more samples

Meter configuration: Width

numberconfig/meters/N/width/
The width of the meter
dot_inline_dotgraph_199.png

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

128

Browse more samples

Meter configuration: Height

numberconfig/meters/N/height/
The height of the meter
dot_inline_dotgraph_200.png

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

request.put({url:"config/meters/"+_meter_configuration_index.toString()+"/height/",body:64});

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

uom.config.meters[_meter_configuration_index].height=64

Browse more samples

Meter configuration: Display scale

stringconfig/meters/N/scale/
The scale function to use for display
dot_inline_dotgraph_201.png

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

"linear"

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

request.get({url:"config/meters/"+_meter_configuration_index.toString()+"/scale/"},function(error,response,body) {console.log(body)});

"linear"

Browse more samples

Meter configuration: Decimals

numberconfig/meters/N/decimals/
Number of decimal places to show in displayed value
dot_inline_dotgraph_202.png

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 CLI write command (note that meter_configuration_index is a variable):

uom set "config/meters/${meter_configuration_index}/decimals" "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/decimals/"

1

Browse more samples

Meter configuration: Arrow color

stringconfig/meters/N/color/
The color of the meter arrow
dot_inline_dotgraph_203.png

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

""

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 "\"\"" "http://192.168.0.100/restapi/config/meters/:meter_configuration_index/color/"

Browse more samples

Meter configuration: Minimum value

numberconfig/meters/N/min_value/
The minimum value to be displayed on the meter
dot_inline_dotgraph_204.png

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

print(uom.dump(uom.config.meters[_meter_configuration_index].min_value))

4

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

0

Browse more samples

Meter configuration: Meter sectors

arrayconfig/meters/N/sectors/
Configuration of meter sectors
dot_inline_dotgraph_205.png

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

request.get({url:"config/meters/"+_meter_configuration_index.toString()+"/sectors/"},function(error,response,body) {console.log(body)});

[{"color":"0000FF","name":"Low","value":100},{"color":"00FF00","name":"Optimal","value":127},{"color":"FF0000","name":"High","value":140}]

Sample JS request sector configuration creation command (note that _meter_configuration_index is a variable):

request.post({url:"config/meters/"+_meter_configuration_index.toString()+"/sectors/",body:{"color":"FF0000","name":"High","value":15}});

Browse more samples

Sector configuration

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

nameName
valueMaximum value
colorColor

Sample uom library deletion command (note that _meter_configuration_index and _sector_configuration_index are variables):

local composite=uom.copy(uom.config.meters[_meter_configuration_index].sectors)
uom.remove(composite,_sector_configuration_index)
uom.config.meters[_meter_configuration_index].sectors=composite

Sample requests read command (note that _meter_configuration_index and _sector_configuration_index are variables):

print(requests.get('http://192.168.0.100/restapi/config/meters/'+str(_meter_configuration_index)+'/sectors/'+str(_sector_configuration_index)+'/',auth=auth,headers=headers).json())

{'color': '00FF00', 'name': 'Optimal', 'value': 13}

Browse more samples

Name

stringconfig/meters/N/sectors/N/name/
The name of the sector
dot_inline_dotgraph_206.png

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 :meter_configuration_index and :sector_configuration_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/meters/:meter_configuration_index/sectors/:sector_configuration_index/name/"

"Optimal"

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"

"High"

Browse more samples

Maximum value

numberconfig/meters/N/sectors/N/value/
The maximum value for the sector
dot_inline_dotgraph_207.png

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 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].value))

4.9

Sample CLI write command (note that meter_configuration_index and sector_configuration_index are variables):

uom set "config/meters/${meter_configuration_index}/sectors/${sector_configuration_index}/value" "4.3"

Browse more samples

Color

stringconfig/meters/N/sectors/N/color/
The color of the sector
dot_inline_dotgraph_208.png

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 requests write command (note that _meter_configuration_index and _sector_configuration_index are variables):

requests.put('http://192.168.0.100/restapi/config/meters/'+str(_meter_configuration_index)+'/sectors/'+str(_sector_configuration_index)+'/color/',auth=auth,headers=headers,json='0000FF')

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()+"/color/",body:"FF0000"});

Browse more samples

Primary unit contact

stringconfig/contact/
The person or entity responsible for this unit and information on how to contact them
dot_inline_dotgraph_209.png

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample CLI read command:

uom get "config/contact"

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

Browse more samples

Related contacts

mapconfig/contacts/
Contacts related to the unit in different ways
dot_inline_dotgraph_210.png

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

requests.put('http://192.168.0.100/restapi/config/contacts/security/',auth=auth,headers=headers,json={'phone': None, 'fax': None, 'name': 'Security', 'email': 'security@foo.example.com'})

Sample JS request write command:

request.put({url:"config/contacts/",body:{"engineering":{"phone":"+3644008591706","fax":null,"name":"Engineering","email":null},"security":{"phone":null,"fax":null,"name":"Security","email":null},"features":{"phone":null,"fax":"+5884166550771","name":"Features","email":"features@foo.example.com"}}});

Browse more samples

See also Related contacts: Contact

Related contacts: Contact

objectconfig/contacts/S/
Contact properties
dot_inline_dotgraph_211.png

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:

nameName
emailEmail, if any
phonePhone number, if any
faxFax number, if any

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

request.get({url:"config/contacts/"+_contact+"/"},function(error,response,body) {console.log(body)});

{"phone":null,"fax":"+25417612324991","name":"Security","email":null}

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

request.delete({url:"config/contacts/"+_contact+"/"});

Browse more samples

Name

stringconfig/contacts/S/name/
Contact name
dot_inline_dotgraph_212.png

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

print(requests.get('http://192.168.0.100/restapi/config/contacts/'+_contact+'/name/',auth=auth,headers=headers).json())

'Engineering'

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

print(uom.dump(uom.config.contacts[_contact].name))

"Sales"

Browse more samples

Email, if any

sum (optional string)config/contacts/S/email/
Contact email address, if any
dot_inline_dotgraph_213.png

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 nullNoneNo email address stored
stringEmailContact email addressthe value is not equal to ""

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

uom get "config/contacts/${contact}/email"

null

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

request.put({url:"config/contacts/"+_contact+"/email/",body:"engineering@baz.example.com"});

Browse more samples

Phone number, if any

sum (optional string)config/contacts/S/phone/
Contact phone number, if any
dot_inline_dotgraph_214.png

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 nullNoneNo phone number stored
stringPhone numberContact phone numberthe value is not equal to ""

Sample requests write command (note that _contact is a variable):

requests.put('http://192.168.0.100/restapi/config/contacts/'+_contact+'/phone/',auth=auth,headers=headers,json='+005283735877738')

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/contacts/:contact/phone/"

"+630903482302563"

Browse more samples

Fax number, if any

sum (optional string)config/contacts/S/fax/
Contact fax number, if any
dot_inline_dotgraph_215.png

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 nullNoneNo fax number stored
stringFax numberContact fax numberthe value is not equal to ""

Sample requests write command (note that _contact is a variable):

requests.put('http://192.168.0.100/restapi/config/contacts/'+_contact+'/fax/',auth=auth,headers=headers,json=None)

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

uom get "config/contacts/${contact}/fax"

"+70192630395999"

Browse more samples

Unit location

stringconfig/location/
The physical location of this unit (e.g. '1st floor, rack 9')
dot_inline_dotgraph_216.png

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample JS request write command:

request.put({url:"config/location/",body:"Server room"});

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/location/',auth=auth,headers=headers,json='Server room')

Browse more samples

Model OID

stringconfig/oid/
Object identifier of unit model (should be registered under dliRegistration OID)
dot_inline_dotgraph_217.png

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.oid))

"1.3.6.1.4.1.45770.1.3"

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"

Browse more samples

Version number

stringconfig/version/
Version number of frontend software
dot_inline_dotgraph_218.png

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

'1.8.1.0'

Sample uom library read command:

print(uom.dump(uom.config.version))

"1.8.1.0"

Browse more samples

Hardware ID

stringconfig/hardware_id/
Identifier of unit hardware model
dot_inline_dotgraph_219.png

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

'EPCR5'

Sample CLI read command:

uom get "config/hardware_id"

"EPCR5"

Browse more samples

Serial number

stringconfig/serial/
Unit's serial number
dot_inline_dotgraph_220.png

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

"DC32203123456"

Sample requests read command:

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

'DC32203123456'

Browse more samples

Outlet label

stringconfig/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 CLI read command:

uom get "config/outlet_label"

"Outlet"

Sample requests read command:

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

'Outlet'

Browse more samples

Brand company name

stringconfig/brand_company_name/
The name of the company which produced the device
dot_inline_dotgraph_221.png

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

"Digital Loggers, Inc."

Sample uom library read command:

print(uom.dump(uom.config.brand_company_name))

"Digital Loggers, Inc."

Browse more samples

Brand name

stringconfig/brand_name/
Default brand name, unless overridden
dot_inline_dotgraph_222.png

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

"Ethernet Power Controller"

Sample requests read command:

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

'Ethernet Power Controller'

Browse more samples

Brand URL

stringconfig/brand_url/
Default brand URL, unless overridden
dot_inline_dotgraph_223.png

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

"https://foo.example.com:8443/bar/bar/foo/foo/quux/bar/foo/foo.html"

Sample requests read command:

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

'http://foo.example.com/bar/quux/bar/bar.html'

Browse more samples

Brand manual URL

stringconfig/brand_manual_url/
Brand product manual URL
dot_inline_dotgraph_224.png

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

'https://baz.example.com:443/foo.html'

Sample curl read command:

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

"http://baz.example.com:8003/foo.html"

Browse more samples

Brand FAQ URL

stringconfig/brand_faq_url/
Brand product FAQ URL
dot_inline_dotgraph_225.png

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

"http://baz.example.com/quux/quux/quux/bar/bar.htm"

Sample requests read command:

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

'http://baz.example.com:8081/foo/quux/baz/foo.htm'

Browse more samples

Brand product information URL

stringconfig/brand_product_info_url/
Brand product information URL
dot_inline_dotgraph_226.png

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample curl read command:

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

"https://bar.example.com:8443/baz.htm"

Sample JS request read command:

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

"http://baz.example.com/baz/quux.htm"

Browse more samples

Support email

stringconfig/support_email/
Product support email
dot_inline_dotgraph_227.png

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample curl read command:

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

"support@example.com"

Sample uom library read command:

print(uom.dump(uom.config.support_email))

"support@example.com"

Browse more samples

Registration URL

stringconfig/register_url/
Default registration URL, unless overridden
dot_inline_dotgraph_228.png

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.register_url))

"http://baz.example.com/foo/baz/bar.html"

Sample CLI read command:

uom get "config/register_url"

"http://baz.example.com:80/baz.html"

Browse more samples

Support URL

stringconfig/support_url/
Default support URL, unless overridden
dot_inline_dotgraph_229.png

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.support_url))

"https://baz.example.com:443/quux/quux/quux/foo/bar/bar.html"

Sample CLI read command:

uom get "config/support_url"

"http://baz.example.com/bar/quux.html"

Browse more samples

Update URL

stringconfig/update_url/
Default update URL, unless overridden
dot_inline_dotgraph_230.png

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample curl read command:

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

"http://baz.example.com:80/bar.html"

Sample requests read command:

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

'https://bar.example.com:8443/quux/baz.htm'

Browse more samples

Custom brand company name, if any

sum (optional string)config/custom_brand_company_name/
User-visible brand company name, if any
dot_inline_dotgraph_231.png

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 nullDefaultUse default brand company name
stringCustom brand company nameUser-visible brand company namethe value is not equal to ""

Sample CLI write command:

uom set "config/custom_brand_company_name" "\"Whatever Systems Inc.\""

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/custom_brand_company_name/',auth=auth,headers=headers,json='Whatever Systems Inc.')

Browse more samples

Custom brand name, if any

sum (optional string)config/custom_brand_name/
User-visible product brand name, if any
dot_inline_dotgraph_232.png

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 nullDefaultUse default product brand name
stringCustom brand nameUser-visible product brand namethe value is not equal to ""

Sample uom library write command:

uom.config.custom_brand_name="Amazing Controller III"

Sample JS request write command:

request.put({url:"config/custom_brand_name/",body:"Amazing Controller III"});

Browse more samples

Custom brand URL, if any

sum (optional string)config/custom_brand_url/
User-visible brand URL, if any
dot_inline_dotgraph_233.png

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 nullDefaultUse default brand URL
stringCustom brand URLUser-visible brand URLthe value is not equal to ""

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"http://foo.example.com/baz.htm\"" "http://192.168.0.100/restapi/config/custom_brand_url/"

Sample uom library write command:

uom.config.custom_brand_url="https://baz.example.com:48443/quux/quux/foo/foo/baz/bar/quux/baz/foo/foo.html"

Browse more samples

Custom brand logo URL, if any

sum (optional string)config/custom_brand_logo/
User-visible brand logo URL, if any
dot_inline_dotgraph_234.png

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 nullDefaultUse default brand logo
stringCustom brand logo URLUser-visible brand logo URLthe value is not equal to ""

Sample JS request write command:

request.put({url:"config/custom_brand_logo/",body:"https://foo.example.com:8443/bar.gif"});

Sample requests read command:

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

'https://baz.example.com/quux/baz/bar.gif'

Browse more samples

Custom brand logo width, if any

sum (optional number)config/custom_brand_logo_width/
User-visible brand logo width, if any
dot_inline_dotgraph_235.png

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 nullDefaultUse default brand logo width
numberCustom brand logo widthUser-visible brand logo width

Sample JS request write command:

request.put({url:"config/custom_brand_logo_width/",body:22});

Sample uom library read command:

print(uom.dump(uom.config.custom_brand_logo_width))

22

Browse more samples

Custom brand logo height, if any

sum (optional number)config/custom_brand_logo_height/
User-visible brand logo height, if any
dot_inline_dotgraph_236.png

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 nullDefaultUse default brand logo height
numberCustom brand logo heightUser-visible brand logo height

Sample JS request read command:

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

32

Sample requests read command:

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

32

Browse more samples

Custom support email, if any

sum (optional string)config/custom_support_email/
User-visible product support email, if any
dot_inline_dotgraph_237.png

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 nullDefaultUse default support email
stringCustom support emailUser-visible product support emailthe value is not equal to ""

Sample uom library read command:

print(uom.dump(uom.config.custom_support_email))

"support@example.com"

Sample CLI write command:

uom set "config/custom_support_email" "\"support@example.com\""

Browse more samples

Custom registration URL, if any

sum (optional string)config/custom_register_url/
User-visible registration URL, if any
dot_inline_dotgraph_238.png

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 nullDefaultUse default registration URL
stringCustom registration URLUser-visible registration URLthe value is not equal to ""

Sample uom library write command:

uom.config.custom_register_url="https://baz.example.com:443/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/baz/bar.html\"" "http://192.168.0.100/restapi/config/custom_register_url/"

Browse more samples

Custom support URL, if any

sum (optional string)config/custom_support_url/
User-visible support URL, if any
dot_inline_dotgraph_239.png

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 nullDefaultUse default support URL
stringCustom support URLUser-visible support URLthe value is not equal to ""

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"http://bar.example.com/bar.htm\"" "http://192.168.0.100/restapi/config/custom_support_url/"

Sample uom library write command:

uom.config.custom_support_url="https://bar.example.com/bar/foo.htm"

Browse more samples

Custom update URL, if any

sum (optional string)config/custom_update_url/
User-visible update URL, if any
dot_inline_dotgraph_240.png

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 nullDefaultUse default update URL
stringCustom update URLUser-visible update URLthe value is not equal to ""

Sample CLI write command:

uom set "config/custom_update_url" "\"http://bar.example.com/baz/baz/baz/baz.htm\""

Sample JS request read command:

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

"https://foo.example.com:443/baz/foo.html"

Browse more samples

Custom help URL, if any

sum (optional string)config/custom_help_url/
User-visible help URL, if any
dot_inline_dotgraph_241.png

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 nullInternal helpUse the internal embedded help system
stringCustom help URLUser-visible help URLthe value is not equal to ""

Sample CLI read command:

uom get "config/custom_help_url"

"https://foo.example.com:28443/bar/quux.html"

Sample uom library read command:

print(uom.dump(uom.config.custom_help_url))

"http://bar.example.com:80/bar.htm"

Browse more samples

Customization status

sum (optional enumerated string)config/customization_status/
Status of customization options
dot_inline_dotgraph_242.png

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 nullDefaultCustomization options can be changed and/or locked
constant "open"OpenCustomization options can be changed, but cannot be locked
constant "locked"LockedCustomization 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 "\"open\"" "http://192.168.0.100/restapi/config/customization_status/"

Sample uom library read command:

print(uom.dump(uom.config.customization_status))

null

Browse more samples

Registration status

sum (boolean)config/registration_status/
Status of the unit registration
dot_inline_dotgraph_243.png

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 trueDefinedThe user has either registered the unit, or refused to do so
constant falseUndefinedThe user hasn't decided on registering the unit and needs to be reminded

Sample uom library read command:

print(uom.dump(uom.config.registration_status))

true

Sample uom library write command:

uom.config.registration_status=false

Browse more samples

Enable page refresh

sum (boolean)config/refresh_enabled/
Periodically refresh web UI status page
dot_inline_dotgraph_244.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample uom library read command:

print(uom.dump(uom.config.refresh_enabled))

true

Sample curl write command:

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

Browse more samples

Page refresh delay

numberconfig/refresh_delay_minutes/
Status page refresh delay, if refresh is enabled
dot_inline_dotgraph_245.png

The value represents time, the standard unit of which is the second (s).

The value is subject to the following constraints: the value is greater than 0

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample JS request read command:

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

1

Sample CLI read command:

uom get "config/refresh_delay_minutes"

1

Browse more samples

Preferred image format

stringconfig/image_format/
Default image format for plots and meters
dot_inline_dotgraph_246.png

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

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

"png"

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/image_format/',auth=auth,headers=headers,json='gif')

Browse more samples

Unit hostname

stringconfig/hostname/
Host name of the unit (sent by DHCP client, redirected to on network configuration changes when next IP address is unknown)
dot_inline_dotgraph_247.png

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 requests write command:

requests.put('http://192.168.0.100/restapi/config/hostname/',auth=auth,headers=headers,json='foo.example.com')

Sample CLI read command:

uom get "config/hostname"

"foo.example.com"

Browse more samples

Time zone

stringconfig/timezone/
System time zone
dot_inline_dotgraph_248.png

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

Sample JS request read command:

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

"UTC"

Browse more samples

HTTP ports

arrayconfig/http_ports/
HTTP port bindings
dot_inline_dotgraph_249.png

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

print(uom.dump(uom.config.http_ports))

Sample requests read command:

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

[{'port': '8074', 'address': '192.168.0.54'}, {'port': '7', 'address': '192.168.0.4'}]

Browse more samples

See also HTTP ports: Port binding

HTTP ports: Port binding

objectconfig/http_ports/N/
Address and port to bind service to
dot_inline_dotgraph_250.png

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:

addressAddress
portPort

Sample uom library deletion command (note that _port_binding_index is a variable):

local composite=uom.copy(uom.config.http_ports)
uom.remove(composite,_port_binding_index)
uom.config.http_ports=composite

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

uom.config.http_ports[_port_binding_index]={address="192.168.0.71",port="80"}

Browse more samples

Address

sum (string)config/http_ports/N/address/
Address to listen on
dot_inline_dotgraph_251.png

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:

stringIPv4 addressIPv4 address to listen onthe 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])$
stringIPv6 addressIPv6 address to listen onthe 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.77"

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 "\"192.168.0.8\"" "http://192.168.0.100/restapi/config/http_ports/:port_binding_index/address/"

Browse more samples

Port

numberconfig/http_ports/N/port/
Port number to bind to
dot_inline_dotgraph_252.png

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

uom get "config/http_ports/${port_binding_index}/port"

"8080"

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

uom set "config/http_ports/${port_binding_index}/port" "\"80\""

Browse more samples

HTTPS ports

arrayconfig/https_ports/
HTTPS port bindings
dot_inline_dotgraph_253.png

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 CLI port binding creation command:

uom insert "config/https_ports/3" "{\"port\":\"80\",\"address\":\"192.168.0.5\"}"

Sample CLI read command:

uom get "config/https_ports"

[{"port":"8007","address":"192.168.0.7"}]

Browse more samples

See also HTTPS ports: Port binding

HTTPS ports: Port binding

objectconfig/https_ports/N/
Address and port to bind service to
dot_inline_dotgraph_254.png

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:

addressAddress
portPort

Sample uom library deletion command (note that _port_binding_index is a variable):

local composite=uom.copy(uom.config.https_ports)
uom.remove(composite,_port_binding_index)
uom.config.https_ports=composite

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

uom remove "config/https_ports/${port_binding_index}"

Browse more samples

Address

sum (string)config/https_ports/N/address/
Address to listen on
dot_inline_dotgraph_255.png

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:

stringIPv4 addressIPv4 address to listen onthe 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])$
stringIPv6 addressIPv6 address to listen onthe 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 JS request read command (note that _port_binding_index is a variable):

request.get({url:"config/https_ports/"+_port_binding_index.toString()+"/address/"},function(error,response,body) {console.log(body)});

"192.168.0.75"

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

uom set "config/https_ports/${port_binding_index}/address" "\"192.168.0.29\""

Browse more samples

Port

numberconfig/https_ports/N/port/
Port number to bind to
dot_inline_dotgraph_256.png

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 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 "\"8010\"" "http://192.168.0.100/restapi/config/https_ports/:port_binding_index/port/"

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

uom set "config/https_ports/${port_binding_index}/port" "\"80\""

Browse more samples

HTTPS certificate settings

objectconfig/https_cert/
HTTPS certificate configuration
dot_inline_dotgraph_257.png

Retrieving the value is denied if not administrative user

This object contains the following items:

bitsBits
distinguished_nameDistinguished name
string_maskString mask
domainsDomain names override, if any
addressesAddresses override, if any
automatic_renewalAutomatic renewal
renewal_methodCertificate renewal method
renewal_dataData
csrHTTPS certificate signing request, if it can be generated
certHTTPS certificate chain
keyHTTPS certificate key
renew_certRenew certificate
generate_keyGenerate key
known_dn_oidsKnown DN OIDs
known_renewal_methodsRenewal methods

Sample requests write command:

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

Sample JS request read command:

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

<...>

Browse more samples

Bits

numberconfig/https_cert/bits/
Size of new private keys
dot_inline_dotgraph_258.png

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 CLI read command:

uom get "config/https_cert/bits"

1024

Sample curl write command:

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

Browse more samples

Distinguished name

mapconfig/https_cert/distinguished_name/
New certificate distinguished name elements
dot_inline_dotgraph_259.png

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 curl values creation command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[\"Santa Clara\"]" "http://192.168.0.100/restapi/config/https_cert/distinguished_name/localityName/"

Sample CLI values creation command:

uom insert "config/https_cert/distinguished_name/stateOrProvinceName" "[\"California\"]"

Browse more samples

See also Distinguished name: Values

String mask

sum (enumerated string)config/https_cert/string_mask/
The set of string types to use for new certificates
dot_inline_dotgraph_260.png

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 defaultPrintableString, T61String and BMPString
constant "pkix"PKIXPrintableString and BMPString
constant "utf8only"UTF-8 strings onlyUTF8String
constant "nombstr"No multibyte stringsPrintableString and T61String

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/https_cert/string_mask/"

"nombstr"

Sample JS request read command:

request.get({url:"config/https_cert/string_mask/"},function(error,response,body) {console.log(body)});

"pkix"

Browse more samples

Domain names override, if any

sum (optional array)config/https_cert/domains/
Explicit domain name list to certify for when enrolling certificate, if any
dot_inline_dotgraph_261.png

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 nullUse hostnameCertify for the current hostname when enrolling certificate
arrayDomain names overrideExplicit domain name list to certify for when enrolling certificate

Sample uom library read command:

print(uom.dump(uom.config.https_cert.domains))

{"foo.example.com","bar.example.com"}

Sample uom library write command:

uom.config.https_cert.domains=null

Browse more samples

See also Domain names override, if any: Domain names override

Addresses override, if any

sum (optional array)config/https_cert/addresses/
Explicit list of addresses to certify for when enrolling certificate, if any
dot_inline_dotgraph_262.png

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 nullUse all known addressesCertify for all current addresses when enrolling certificate automatically
arrayAddresses overrideExplicit list of addresses to certify for when enrolling certificate

Sample CLI read command:

uom get "config/https_cert/addresses"

["164.252.66.251","253.2.251.8","8.250.239.252","251.251.227.255"]

Sample uom library read command:

print(uom.dump(uom.config.https_cert.addresses))

{"250.222.3.3"}

Browse more samples

See also Addresses override, if any: Addresses override

Automatic renewal

sum (boolean)config/https_cert/automatic_renewal/
Automatic renewal of certificate at or near expiry
dot_inline_dotgraph_263.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample curl write command:

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

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/config/https_cert/automatic_renewal/',auth=auth,headers=headers).json())

False

Browse more samples

Certificate renewal method

stringconfig/https_cert/renewal_method/
Method to use when renewing the certificate
dot_inline_dotgraph_264.png

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

print(uom.dump(uom.config.https_cert.renewal_method))

"acmev1"

Sample uom library write command:

uom.config.https_cert.renewal_method="acmev1"

Browse more samples

See also HTTPS certificate settings: Data

HTTPS certificate signing request, if it can be generated

sum (variant)config/https_cert/csr/
The certificate signing request to sign (read may fail if key generation is in progress)
dot_inline_dotgraph_265.png

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:

stringHTTPS certificate signing requestThe 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 falseCertificate signing request generation failureNo valid certificate signing request could be generated, check distinguished name settings

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/config/https_cert/csr/',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/https_cert/csr/"

"-----BEGIN CERTIFICATE REQUEST-----\nMIIcOf1Fy7hQcaW9w1w11DE5naOYptd35vhVbknZuU/W5Xi1be4fuLmhyAFo4vtC\njSLX1F23o9dWDEBKw5hipgv4U00NEt++LLYPccUQn8z1PBNLJ548n0FH2HgIBgJY\ntzgV=\n-----END CERTIFICATE REQUEST-----\n"

Browse more samples

HTTPS certificate chain

stringconfig/https_cert/cert/
HTTPS certificate chain presented by the unit to clients (read may fail if renewal is in progress)
dot_inline_dotgraph_266.png

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

Sample CLI read command:

uom get "config/https_cert/cert"

"-----BEGIN CERTIFICATE-----\nMIIow91KPwAhQDX0PXQ2nWf9qeTIxt7fWUTSgXo5T/ovEMygvOkjxQvn4O51IFiq\nIRl7ZF8NBPl95hasRYIMLPnTS5lBxWQG+BPZSazf/kr6SS/v1JHPk5uDCgRACtSD\nuoaUnFW=\n-----END CERTIFICATE-----\n"

Browse more samples

HTTPS certificate key

stringconfig/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
dot_inline_dotgraph_267.png

The value contains PEM format data (has native MIME type application/x-pem-file).

Retrieving the value is denied

Changing the value is denied if not administrative user

Using the string as a field for indexing into the grandparent collection is denied

This string represents a value in persistent storage.

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

Changes to this string cannot be tracked.

Changes to this string may have an effect besides setting value.

Changes to this string do not take effect immediately.

This string should be displayed in a secure manner.

Representation of the resource cannot be obtained. Attempts to do so via a JSON API will succeed but return '{"$ref":""}' which means "the value of this resource".

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/https_cert/key/',auth=auth,headers=headers,json='-----BEGIN PRIVATE KEY-----\nMIIBwADZp0o+kE2ItIRqni5uoj+eqxSVWpjT0y2r/tsl8w41FYt2H+z5kzmaxF6T\ny7p1/rxtd6qjA5I4Ab59jr8VR5mZbtRa1He28cynkoXwwr16S8HB/SjTaV2CPWoS\nTXz5VnsJKpFBsOg0hu2AdXm9c+b8p3zJdzQ8mJU78mK1A14tx84ahsmJtNUjTT26\nUHFqnO/Zl2mo9gmKmM1e9NYYtH1NLAssT8iGZksLpe9+KyK6KOnVoL4he750K+up\nd5kN+6CeID/GZ7d+x9oIFWzPd/lewapaia+iiDN0SPI2Zx2W6trOPqp3sakoBZPw\nPfue2x7UFB3DGbMASmcJchBDR0Q1RMDs18X65gcNuidBJ/Noo/7QjKgBM6EqVUjZ\nGilzL9t3o5OqUDfWM6GioT5xkySEh2uzngy8rsDgzeWUtB1GJJ/8o65Y5aooejnR\nmcHeszdXW8RkBj3WkDLtLv+xkocTc4vOiD3aCj8ltbV4Kbd5r++Cw/9gpoASu5tc\nyDZhNKb/riLTLSKMTYIUk+=\n-----END PRIVATE KEY-----\n')

Sample JS request write command:

request.put({url:"config/https_cert/key/",body:"-----BEGIN PRIVATE KEY-----\nMIIJkxuFP9+cyfDZqFjikjrSE/ZteFycmTyWQsos2oU0UjcK/M2l6wEMxpGc5EEt\nQA6E2A3ZDZJswKF+6NxMmuC2WJInD21gF9wJM0vccEVYbmZkAW7yQL0zhLmxQpdh\na1=\n-----END PRIVATE KEY-----\n"});

Browse more samples

See also HTTPS certificate settings: Renew certificate

See also HTTPS certificate settings: Generate key

See also HTTPS certificate settings: Known DN OIDs

Renewal methods

mapconfig/https_cert/known_renewal_methods/
Known renewal methods
dot_inline_dotgraph_268.png

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Renewal method elements.

Creating elements in this collection is not supported.

Sample CLI read command:

uom get "config/https_cert/known_renewal_methods"

...

Sample uom library read command:

print(uom.dump(uom.config.https_cert.known_renewal_methods))

<...>

Browse more samples

See also Renewal methods: Renewal method

Distinguished name: Values

arrayconfig/https_cert/distinguished_name/S/
Distinguished name element value set
dot_inline_dotgraph_269.png

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

print(uom.dump(uom.config.https_cert.distinguished_name[_values]))

{"Digital Loggers Unit"}

Sample uom library deletion command (note that _values is a variable):

local composite=uom.copy(uom.config.https_cert.distinguished_name)
uom.remove(composite,_values)
uom.config.https_cert.distinguished_name=composite

Browse more samples

Value

stringconfig/https_cert/distinguished_name/S/N/
Distinguished name element value
dot_inline_dotgraph_270.png

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 CLI read command (note that values and value_index are variables):

uom get "config/https_cert/distinguished_name/${values}/${value_index}"

"Digital Loggers Unit"

Sample JS request write command (note that _values and _value_index are variables):

request.put({url:"config/https_cert/distinguished_name/"+_values+"/"+_value_index.toString()+"/",body:"California"});

Browse more samples

Domain names override, if any: Domain names override

(possibly) arrayconfig/https_cert/domains/
Explicit domain name list to certify for when enrolling certificate

This array contains Hostname elements.

Sample JS request hostname creation command:

request.post({url:"config/https_cert/domains/",body:"bar.example.com"});

Sample curl hostname creation command:

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"bar.example.com\"" "http://192.168.0.100/restapi/config/https_cert/domains/"

Browse more samples

Hostname

stringconfig/https_cert/domains/N/
Hostname to certify for
dot_inline_dotgraph_271.png

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

uom get "config/https_cert/domains/${hostname_index}"

"baz.example.com"

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

print(uom.dump(uom.config.https_cert.domains[_hostname_index]))

"baz.example.com"

Browse more samples

Addresses override, if any: Addresses override

(possibly) arrayconfig/https_cert/addresses/
Explicit list of addresses to certify for when enrolling certificate

This array contains IPv4 address elements.

Sample curl IPv4 address creation command:

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"127.253.2.198\"" "http://192.168.0.100/restapi/config/https_cert/addresses/"

Sample uom library IPv4 address creation command:

uom.insert(uom.config.https_cert.addresses,3,"250.20.9.29")

Browse more samples

IPv4 address

stringconfig/https_cert/addresses/N/
IPv4 address to certify for, in dotted quad notation
dot_inline_dotgraph_272.png

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 uom library write command (note that _ipv4_address_index is a variable):

uom.config.https_cert.addresses[_ipv4_address_index]="129.222.96.252"

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

request.get({url:"config/https_cert/addresses/"+_ipv4_address_index.toString()+"/"},function(error,response,body) {console.log(body)});

"251.110.106.39"

Browse more samples

HTTPS certificate settings: Data

mapconfig/https_cert/renewal_data/
Renewal-method-specific data
dot_inline_dotgraph_273.png

Retrieving the value is denied if not administrative user

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

This map represents a value in persistent storage.

This map contains Data item elements.

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/https_cert/renewal_data/"

{"acmev2_agreement":"q     ]l","acmev2_contacts":"/  K","acmev2_auth_algorithm":"RS384","acmev2_url":"http://]"}

Sample curl data item creation command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"https://]\"" "http://192.168.0.100/restapi/config/https_cert/renewal_data/est_url/"

Browse more samples

Data item

stringconfig/https_cert/renewal_data/S/
Item of renewal-method-specific data
dot_inline_dotgraph_274.png

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 JS request write command (note that _data_item is a variable):

request.put({url:"config/https_cert/renewal_data/"+_data_item+"/",body:"http://B]"});

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

uom set "config/https_cert/renewal_data/${data_item}" "\"]\""

Browse more samples

HTTPS certificate settings: Renew certificate

callconfig/https_cert/renew_cert/
Initiate attempt to renew the certificate using the selected method
dot_inline_dotgraph_275.png

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:

  1. Empty result: null

Sample requests invocation:

requests.post('http://192.168.0.100/restapi/config/https_cert/renew_cert/',auth=auth,headers=headers,json={})

(no output)

Sample curl invocation:

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[]" "http://192.168.0.100/restapi/config/https_cert/renew_cert/"

null

Browse more samples

Empty result

constant nullconfig/https_cert/renew_cert/results: 1/
No additional information available

This constant does not correspond to an actual resource.

HTTPS certificate settings: Generate key

callconfig/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
dot_inline_dotgraph_276.png

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:

  1. Empty result: null

Sample JS request invocation:

request.post({url:"config/https_cert/generate_key/",body:[]});

(no output)

Sample uom library invocation:

uom.config.https_cert.generate_key()

(no output)

Browse more samples

Empty result

constant nullconfig/https_cert/generate_key/results: 1/
No additional information available

This constant does not correspond to an actual resource.

HTTPS certificate settings: Known DN OIDs

mapconfig/https_cert/known_dn_oids/
Known distinguished name element object identifiers
dot_inline_dotgraph_277.png

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

print(uom.dump(uom.config.https_cert.known_dn_oids))

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/https_cert/known_dn_oids/"

Browse more samples

OID

stringconfig/https_cert/known_dn_oids/S/
Object identifier value
dot_inline_dotgraph_278.png

Retrieving the value is denied if not administrative user

This string does not support direct modification.

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

print(uom.dump(uom.config.https_cert.known_dn_oids[_oid]))

"2.5.4.16"

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.20"

Browse more samples

Supported data items: Data item properties

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

nameName
regexpRegular expression
secretSecret

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]*$","name":"Number of days to issue new certificates for","secret":false}

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

uom get "config/https_cert/known_renewal_methods/${renewal_method}/data_items/${data_item_properties}"

{"regexp":"^((]|[!#&'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))| )+$","name":"ACMEv2 contact URLs, whitespace-separated","secret":false}

Browse more samples

Name

stringconfig/https_cert/known_renewal_methods/S/data_items/S/name/
Data item name
dot_inline_dotgraph_279.png

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

"EST server base URL (not including .well-known/...; secure transport required)"

Browse more samples

Regular expression

stringconfig/https_cert/known_renewal_methods/S/data_items/S/regexp/
Regular expression which the data item must match
dot_inline_dotgraph_280.png

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

'^(|basic|digest)$'

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].regexp))

"^https://(]|[!#&'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))+$"

Browse more samples

Secret

sum (boolean)config/https_cert/known_renewal_methods/S/data_items/S/secret/
Flag indicating whether the data item can contain private information
dot_inline_dotgraph_281.png

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

This sum can assume the following values:

constant trueSecretThe data item can contain private information
constant falseNot secretThe data item contains only public information

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

uom get "config/https_cert/known_renewal_methods/${renewal_method}/data_items/${data_item_properties}/secret"

false

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].secret))

false

Browse more samples

Renewal methods: Renewal method

objectconfig/https_cert/known_renewal_methods/S/
Method of certificate renewal
dot_inline_dotgraph_282.png

Retrieving the value is denied if not administrative user

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

This object contains the following items:

nameName
data_itemsSupported data items

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

uom set "config/https_cert/known_renewal_methods/${renewal_method}" "{\"name\":\"Obtain a certificate via EST (Enrollment over Secure Transport)\",\"data_items\":{\"password\":{\"regexp\":\"[ -~]*\",\"name\":\"Password to use for authentication\",\"secret\":true},\"username\":{\"regexp\":\"[A-Za-z_-][A-Za-z0-9_@-]*\",\"name\":\"Username to authenticate as\",\"secret\":false},\"est_url\":{\"regexp\":\"^https://(]|[!#&'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))+$\",\"name\":\"EST server base URL (not including .well-known/...; secure transport required)\",\"secret\":false},\"auth\":{\"regexp\":\"^(|basic|digest)$\",\"name\":\"HTTP authentication to use\",\"secret\":false}}}"

Sample requests write command (note that _renewal_method is a variable):

requests.put('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}}})

Browse more samples

Name

stringconfig/https_cert/known_renewal_methods/S/name/
Renewal method name
dot_inline_dotgraph_283.png

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

uom get "config/https_cert/known_renewal_methods/${renewal_method}/name"

"Obtain a certificate from an ACME v2 endpoint (e.g. Let's Encrypt)"

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

'Obtain a certificate from an ACME v1 endpoint (e.g. Let\'s Encrypt)'

Browse more samples

Supported data items

mapconfig/https_cert/known_renewal_methods/S/data_items/
Properties of supported data items
dot_inline_dotgraph_284.png

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Data item properties elements.

Creating elements in this collection is not supported.

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

print(uom.dump(uom.config.https_cert.known_renewal_methods[_renewal_method].data_items))

{days={name="Number of days to issue new certificates for",regexp="^[1-9][0-9]*$",secret=false}}

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

Browse more samples

See also Supported data items: Data item properties

Certificate collection

mapconfig/certificates/
Map of known certificates and their settings
dot_inline_dotgraph_285.png

Retrieving the value is denied if not administrative user

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

This map represents a value in persistent storage.

Changes to this map do not take effect immediately.

This map contains Certificate elements.

Sample requests read command:

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

Sample 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-----\\nMIIKaaafsw+dYaR3HwT63GpqRkqCo2zxmGINtu2lr3OQfsVzo/6uIxllic+WgzUS\\ns8jxwb0K1iDZi2aryuojgWLg32gZXyOP68M3mPQp8fPsj/jhwYRd5pJAt0mQ+Ar7\\nEC7fezpKOi3QSnM0E/83LKzO6POJHYhXmqDRp2nEntgFg2Ix4S1Sp0sxRHHkr+Ie\\nX6hcvxPpehVj0SpVVIKXAI/UcmLd40Ue8CG4AivqPQZSvPzQjK+wf0QHonwvpRZ+\\nr4sZ/i/RHTMjTpSpqOVtrohfldVCCVu4bmfcVh4pATYgJ0WAR13Jsn+dQVse0nke\\nQH57NwKtU0CXYO/cUKUHL8js1Nvq8aRatYjH=\\n-----END CERTIFICATE-----\\n\",\"status\":true}" "http://192.168.0.100/restapi/config/certificates/eCyberBazWard_Primary_Certification_Authority/"

Browse more samples

See also Certificate collection: Certificate

Certificate collection: Certificate

objectconfig/certificates/S/
Certificate settings
dot_inline_dotgraph_286.png

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:

dataData
statusTrust status

Sample uom library deletion command (note that _certificate is a variable):

uom.remove(uom.config.certificates,_certificate)

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

request.put({url:"config/certificates/"+_certificate+"/",body:{"data":"-----BEGIN CERTIFICATE-----\nMII0kfw0pt+W+bi+kIkDxRK98qNpClms12vnkrqZkq5lSqmC9WS7+oI8fi+tTmmW\nKbYAAJ1I5V9tkKQCUQ1obiWbc0OOZF5vsg630AN7hY1SvTgPwkEXSn95qaWPseLk\nTqNfDXNoark3YA0IRanElv\n-----END CERTIFICATE-----\n","status":true}});

Browse more samples

Data

stringconfig/certificates/S/data/
Certificate data
dot_inline_dotgraph_287.png

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

print(requests.get('http://192.168.0.100/restapi/config/certificates/'+_certificate+'/data/',auth=auth,headers=headers).json())

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

print(uom.dump(uom.config.certificates[_certificate].data))

Browse more samples

Trust status

sum (boolean)config/certificates/S/status/
Whether the certificate is trusted by default
dot_inline_dotgraph_288.png

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 trueTrustedThe certificate is trusted by all software with default settings
constant falseUntrustedThe certificate is not trusted by all software with default settings

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

uom.config.certificates[_certificate].status=false

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/certificates/:certificate/status/"

true

Browse more samples

Certificate revocation list collection

mapconfig/crls/
Map of known certificate revocation lists and their settings
dot_inline_dotgraph_289.png

Retrieving the value is denied if not administrative user

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

This map represents a value in persistent storage.

Changes to this map do not take effect immediately.

This map contains Certificate revocation list elements.

Sample requests read command:

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

Sample uom library read command:

print(uom.dump(uom.config.crls))

Browse more samples

See also Certificate revocation list collection: Certificate revocation list

Certificate revocation list collection: Certificate revocation list

objectconfig/crls/S/
Certificate revocation list settings
dot_inline_dotgraph_290.png

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:

dataData
statusUsage status

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

uom remove "config/crls/${certificate_revocation_list}"

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

Browse more samples

Data

stringconfig/crls/S/data/
CRL data
dot_inline_dotgraph_291.png

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

print(uom.dump(uom.config.crls[_certificate_revocation_list].data))

"-----BEGIN X509 CRL-----\
MIIlVZKOH61zmN+gGik3iYQUySJ8MmV3b2r6eBWxKaw7zxpFfaKN8nu7GEHe0pkd\
mYpJVAvSJuP9A5lXVwKQ3dgMIjB2N5gAfVVBiRg1L6CXDz5lwRB/5uOPebT2jAEP\
mdQDJTaRh8hhFSdjgfqb3FFhlJRxasfMV6brbCJJM00e=\
-----END X509 CRL-----\
"

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

uom set "config/crls/${certificate_revocation_list}/data" "\"-----BEGIN X509 CRL-----\\nMIIaByo4rviRdRuyg+b0DjZAUZzANip8l1kz/Y3sUoJ7GE5yFj/VSbhzAh9aP+kB\\nA33GxZ5HjOYrMpaOK3/12CkEoAEYOI3bN9tLl/eUPDLo2yCP2ET7SENHQesryySL\\nLiuNNOocmchkr6p6byasLuI/m9+ldLu/4oPUDD70sqnkzcsbaTTyNo+A++xeLsgS\\n5yxL5zDym+yPsZ0M3+mt+yt+wXMoErWLpTixSywFyuhrUjDZk0Sl+Mmxw8mA/IXr\\nGpGEmYDgF5B+LmlNFWOdILaS8mUSKMGcCYs+66gODtOag9zxiNa0lAVvz/OJOgxc\\nqcOzJoCDCpvOos6CT9zggvghJ/60zkHqNhpiV2xktt9ilIxFTwy9setBg0EfmXWA\\nMunQsYKlk3X30oYzmkrRe37gJoTtLf8jayATWWEGcnLecwdPhVsLa02vrXoCDzxq\\n8JUgZnJN9z05dRp8KAlMEhDoWS2VPuTZDzGpmbCxbE3EiuP35ASMuhAQ9Fyb9RBP\\nUEE6SCjjH+SCPYJc0hWkuzv9xXLOlmsF06NVK6Fd6ksYIBBKvk4qj00gZN5KAzcC\\n/kR8/5Hlzr4B3Q6pWzYZ/E8PMVbL8qT9awJc2cO2UUFZwOPTOz2PEDqdlR+vHT5u\\nRXV3xZaSrAPGbugbz5sDyV/PWxj\\n-----END X509 CRL-----\\n\""

Browse more samples

Usage status

sum (boolean)config/crls/S/status/
Whether the certificate revocation list is used by default
dot_inline_dotgraph_292.png

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 trueUsedThe certificate revocation list is used by all software with default settings
constant falseUnusedThe certificate revocation list is not used by all software with default settings

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

uom.config.crls[_certificate_revocation_list].status=true

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

request.put({url:"config/crls/"+_certificate_revocation_list+"/status/",body:false});

Browse more samples

SSH enabled

sum (boolean)config/ssh_enabled/
Whether the SSH server should be enabled
dot_inline_dotgraph_293.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample curl write command:

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

Sample JS request write command:

request.put({url:"config/ssh_enabled/",body:false});

Browse more samples

SSH port number

numberconfig/ssh_port/
Port number of the SSH server
dot_inline_dotgraph_294.png

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 curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/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

Browse more samples

SSH authorized keys

arrayconfig/ssh_authorized_keys/
List of public keys allowed to log in
dot_inline_dotgraph_295.png

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 curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[{\"data\":\"ecdsa-sha2-nistp256   Cx\",\"options\":\"\",\"comment\":\"e\"},{\"data\":\"ecdsa-sha2-nistp384        X==\",\"options\":\"\",\"comment\":\"dpem\"},{\"data\":\"ecdsa-sha2-nistp256       L2S==\",\"options\":\"\",\"comment\":\"e\"},{\"data\":\"ssh-dss   h=\",\"options\":\"hwkunbg=dm,vu=tl\",\"comment\":\"mjrjign\"},{\"data\":\"ssh-ed25519 V===\",\"options\":\"h=a,irv\",\"comment\":\"\"}]" "http://192.168.0.100/restapi/config/ssh_authorized_keys/"

Sample uom library write command:

uom.config.ssh_authorized_keys={{comment="",data="ecdsa-sha2-nistp521 3VXkuISu===",options="f=37"}}

Browse more samples

See also SSH authorized keys: SSH authorized key

SSH authorized keys: SSH authorized key

objectconfig/ssh_authorized_keys/N/
Public key allowed to log in
dot_inline_dotgraph_296.png

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:

dataData
optionsOptions
commentComment

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 "{\"data\":\"ecdsa-sha2-nistp256    xc+m\",\"options\":\"\",\"comment\":\"k\"}" "http://192.168.0.100/restapi/config/ssh_authorized_keys/:ssh_authorized_key_index/"

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

print(uom.dump(uom.config.ssh_authorized_keys[_ssh_authorized_key_index]))

{comment="gdn.qg.wpykqdb",data="ssh-ed25519   sN0===",options="gupxjs=6,j=1,jgpzrnoot=2,o=ax,vg=icgsjv"}

Browse more samples

Data

stringconfig/ssh_authorized_keys/N/data/
Public key data
dot_inline_dotgraph_297.png

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 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  P')

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 "\"ecdsa-sha2-nistp521         4b\"" "http://192.168.0.100/restapi/config/ssh_authorized_keys/:ssh_authorized_key_index/data/"

Browse more samples

Options

stringconfig/ssh_authorized_keys/N/options/
Public key options
dot_inline_dotgraph_298.png

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 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)+'/options/',auth=auth,headers=headers,json='rgg=clun,qv=6')

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

uom get "config/ssh_authorized_keys/${ssh_authorized_key_index}/options"

""

Browse more samples

Comment

stringconfig/ssh_authorized_keys/N/comment/
Public key comment
dot_inline_dotgraph_299.png

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 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)+'/comment/',auth=auth,headers=headers,json='s@gdb-a')

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

print(uom.dump(uom.config.ssh_authorized_keys[_ssh_authorized_key_index].comment))

""

Browse more samples

NTP server enabled

sum (boolean)config/ntp_server_enabled/
Whether the device should act as NTP server
dot_inline_dotgraph_300.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample uom library read command:

print(uom.dump(uom.config.ntp_server_enabled))

false

Sample JS request write command:

request.put({url:"config/ntp_server_enabled/",body:true});

Browse more samples

NTP peers

arrayconfig/ntp_peers/
List of NTP servers to get time information from
dot_inline_dotgraph_301.png

Retrieving the value is denied if not administrative user

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

This array represents a value in persistent storage.

Changes to this array do not take effect immediately.

This array contains NTP peer elements.

Sample uom library read command:

print(uom.dump(uom.config.ntp_peers))

{"0.ntp-pool.example.com","1.ntp-pool.example.com","2.ntp-pool.example.com","3.ntp-pool.example.com"}

Sample curl read command:

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

["0.ntp-pool.example.com","1.ntp-pool.example.com","2.ntp-pool.example.com","3.ntp-pool.example.com"]

Browse more samples

NTP peer

sum (string)config/ntp_peers/N/
NTP server to get time information from
dot_inline_dotgraph_302.png

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:

stringHostnameHostnamethe 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])?)$
stringIPv4 addressIPv4 address in dotted quad notationthe value matches ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

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

uom get "config/ntp_peers/${ntp_peer_index}"

"2.ntp-pool.example.com"

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

Browse more samples

Syslog threshold severity

sum (enumerated number)config/syslog_minimal_severity/
Threshold severity for system messages, below which they are not logged
dot_inline_dotgraph_303.png

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 1EmergencyLog when unit becomes unstable or unusable
constant 2AlertLog conditions requiring immediate action
constant 3CriticalLog critical conditions
constant 4ErrorLog error conditions
constant 5WarningLog warning conditions
constant 6NoticeLog normal but significant conditions
constant 7InformationalLog informational messages
constant 8DebugLog tracing and debugging messages

Sample uom library write command:

uom.config.syslog_minimal_severity=8

Sample uom library read command:

print(uom.dump(uom.config.syslog_minimal_severity))

8

Browse more samples

Syslog server address, if any

sum (optional string)config/syslog_ip_address/
Host name or IPv4 address of the syslog server to forward log messages to, if any
dot_inline_dotgraph_304.png

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 nullSyslog server disabledSystem log messages are not forwarded to a server
stringHostnameHostnamethe 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])?)$
stringIPv4 addressIPv4 address in dotted quad notationthe 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 uom library write command:

uom.config.syslog_ip_address=null

Sample CLI write command:

uom set "config/syslog_ip_address" "null"

Browse more samples

Allow JSON-RPC

sum (boolean)config/allow_jsonrpc/
Enable HTTP clients to perform JSON-RPC requests
dot_inline_dotgraph_305.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample JS request write command:

request.put({url:"config/allow_jsonrpc/",body:true});

Sample CLI write command:

uom set "config/allow_jsonrpc" "true"

Browse more samples

Allow non-administrative users to perform JSON-RPC requests

sum (boolean)config/allow_jsonrpc_nonadmin/
Enable JSON-RPC API requests from users which are not administrators
dot_inline_dotgraph_306.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample JS request write command:

request.put({url:"config/allow_jsonrpc_nonadmin/",body:true});

Sample uom library read command:

print(uom.dump(uom.config.allow_jsonrpc_nonadmin))

true

Browse more samples

Allow REST-like API

sum (boolean)config/allow_restapi/
Enable HTTP clients to perform REST-like API requests
dot_inline_dotgraph_307.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample uom library read command:

print(uom.dump(uom.config.allow_restapi))

true

Sample CLI write command:

uom set "config/allow_restapi" "true"

Browse more samples

Allow non-administrative users to access REST-like API

sum (boolean)config/allow_restapi_nonadmin/
Enable REST-like API requests from users which are not administrators
dot_inline_dotgraph_308.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample curl write command:

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

Sample JS request write command:

request.put({url:"config/allow_restapi_nonadmin/",body:true});

Browse more samples

Allowed REST-like API client origins

arrayconfig/allow_restapi_origins/
List of origins permitted to access the REST-like API
dot_inline_dotgraph_309.png

Retrieving the value is denied if not administrative user

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

This array represents a value in persistent storage.

This array contains Allowed REST-like API client origin elements.

Sample JS request allowed REST-like API client origin creation command:

request.post({url:"config/allow_restapi_origins/",body:"https://foo.example.com"});

Sample uom library allowed REST-like API client origin creation command:

uom.insert(uom.config.allow_restapi_origins,1,"https://baz.example.com:443")

Browse more samples

Allowed REST-like API client origin

stringconfig/allow_restapi_origins/N/
Origin permitted to access the REST-like API
dot_inline_dotgraph_310.png

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

Sample requests write command (note that _allowed_rest_like_api_client_origin_index is a variable):

requests.put('http://192.168.0.100/restapi/config/allow_restapi_origins/'+str(_allowed_rest_like_api_client_origin_index)+'/',auth=auth,headers=headers,json='http://bar.example.com:4')

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()+"/"});

Browse more samples

Allow CoAP over WebSockets

sum (boolean)config/allow_coapws/
Enable HTTP clients to establish CoAP over WebSockets connections
dot_inline_dotgraph_311.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample curl write command:

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

Sample uom library read command:

print(uom.dump(uom.config.allow_coapws))

true

Browse more samples

Allow non-administrative users to access CoAP over WebSockets

sum (boolean)config/allow_coapws_nonadmin/
Enable CoAP over WebSockets connections from users which are not administrators
dot_inline_dotgraph_312.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/config/allow_coapws_nonadmin/',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/allow_coapws_nonadmin/"

false

Browse more samples

Allowed CoAP over WebSockets client origins

arrayconfig/allow_coapws_origins/
List of origins permitted to access CoAP over WebSockets
dot_inline_dotgraph_313.png

Retrieving the value is denied if not administrative user

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

This array represents a value in persistent storage.

This array contains Allowed CoAP over WebSockets client origin elements.

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[\"https://baz.example.com\",\"https://baz.example.com\"]" "http://192.168.0.100/restapi/config/allow_coapws_origins/"

Sample curl allowed CoAP over WebSockets client origin creation command:

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"http://baz.example.com\"" "http://192.168.0.100/restapi/config/allow_coapws_origins/"

Browse more samples

Allowed CoAP over WebSockets client origin

stringconfig/allow_coapws_origins/N/
Origin permitted to access CoAP over WebSockets
dot_inline_dotgraph_314.png

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

Sample requests deletion command (note that _allowed_coap_over_websockets_client_origin_index is a variable):

requests.delete('http://192.168.0.100/restapi/config/allow_coapws_origins/'+str(_allowed_coap_over_websockets_client_origin_index)+'/',auth=auth,headers=headers)

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

request.put({url:"config/allow_coapws_origins/"+_allowed_coap_over_websockets_client_origin_index.toString()+"/",body:"https://baz.example.com"});

Browse more samples

Relax non-HTML method CSRF checks

sum (boolean)config/relax_nonhtml_methods/
Enable HTTP clients to perform PUT/PATCH/DELETE API requests without a CSRF protection header (currently cannot be sent via an HTML form)
dot_inline_dotgraph_315.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample curl write command:

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

Sample requests read command:

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

True

Browse more samples

Relax non-HTML content type CSRF checks

sum (boolean)config/relax_nonhtml_content_types/
Enable HTTP clients to perform API requests with e.g. application/json or application/json-rpc without a CSRF protection header (currently cannot be sent via an HTML form)
dot_inline_dotgraph_316.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample curl read command:

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

true

Sample uom library write command:

uom.config.relax_nonhtml_content_types=true

Browse more samples

Allow plaintext logins

sum (boolean)config/allow_plaintext_logins/
Allow HTTP clients to authenticate using Basic authentication or plaintext login form
dot_inline_dotgraph_317.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample curl read command:

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

true

Sample uom library write command:

uom.config.allow_plaintext_logins=true

Browse more samples

Allow plaintext URL logins

sum (boolean)config/allow_plaintext_url_logins/
Allow HTTP clients to authenticate to certain API types by supplying plaintext credentials in URL
dot_inline_dotgraph_318.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/allow_plaintext_url_logins/',auth=auth,headers=headers,json={})

Sample curl write command:

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

Browse more samples

Allow state-changing GET requests

sum (boolean)config/allow_modifying_get/
Allow HTTP clients to use GET web UI requests for changing state
dot_inline_dotgraph_319.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample JS request read command:

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

true

Sample uom library read command:

print(uom.dump(uom.config.allow_modifying_get))

false

Browse more samples

Relay name visibility

sum (boolean)config/name_always_visible/
Flag enabling visibility of relay name
dot_inline_dotgraph_320.png

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 trueEverywhereRelay name visible everywhere, including the login page
constant falseAuthorized users onlyRelay name visible only on pages which require authorization

Sample requests read command:

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

True

Sample uom library write command:

uom.config.name_always_visible=false

Browse more samples

Hide user passwords

sum (boolean)config/hide_passwords/
Whether user passwords should be hidden
dot_inline_dotgraph_321.png

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 trueHideDo not display user passwords in web UI
constant falseShowDisplay user passwords in web UI

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

Sample uom library read command:

print(uom.dump(uom.config.hide_passwords))

true

Browse more samples

Hide WiFi key

sum (boolean)config/hide_wifi_key/
Whether the WiFi key should be hidden
dot_inline_dotgraph_322.png

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 trueHideDo not display WiFi key in web UI
constant falseShowDisplay WiFi key in web UI

Sample requests read command:

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

False

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/hide_wifi_key/',auth=auth,headers=headers,json=True)

Browse more samples

Security lockout duration

numberconfig/lockout_delay_minutes/
Time during which, after several unsuccessful logins, subsequent logins are denied
dot_inline_dotgraph_323.png

The value represents time, the standard unit of which is the second (s).

The value is subject to the following constraints: the value is greater or equal to 0

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/lockout_delay_minutes/',auth=auth,headers=headers,json=60)

Sample JS request write command:

request.put({url:"config/lockout_delay_minutes/",body:60});

Browse more samples

Protect firmware

sum (boolean)config/protect_firmware/
Protect firmware from being overwritten
dot_inline_dotgraph_324.png

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 trueProtectedAssociated object cannot be changed
constant falseNot protectedAssociated object can be changed

Sample JS request write command:

request.put({url:"config/protect_firmware/",body:true});

Sample CLI write command:

uom set "config/protect_firmware" "true"

Browse more samples

Protect admin login

sum (boolean)config/protect_admin/
Protect admin settings from being modified
dot_inline_dotgraph_325.png

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 trueProtectedAssociated object cannot be changed
constant falseNot protectedAssociated 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 "true" "http://192.168.0.100/restapi/config/protect_admin/"

Sample requests read command:

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

False

Browse more samples

Protect network settings

sum (boolean)config/protect_network/
Protect network settings from being modified
dot_inline_dotgraph_326.png

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 trueProtectedAssociated object cannot be changed
constant falseNot protectedAssociated object can be changed

Sample curl read command:

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

false

Sample uom library write command:

uom.config.protect_network=false

Browse more samples

Protect private settings

sum (boolean)config/protect_private_config/
Protect private configuration settings from being stored in backups
dot_inline_dotgraph_327.png

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 trueProtectedAssociated object cannot be changed
constant falseNot protectedAssociated object can be changed

Sample uom library read command:

print(uom.dump(uom.config.protect_private_config))

false

Sample curl write command:

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

Browse more samples

Protect from restore

sum (boolean)config/protect_restore/
Protect settings from being restored from backups
dot_inline_dotgraph_328.png

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 trueProtectedAssociated object cannot be changed
constant falseNot protectedAssociated object can be changed

Sample uom library read command:

print(uom.dump(uom.config.protect_restore))

true

Sample JS request write command:

request.put({url:"config/protect_restore/",body:false});

Browse more samples

Protect from maintenance

sum (boolean)config/protect_maintenance/
Disable remote maintenance support
dot_inline_dotgraph_329.png

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 trueProtectedAssociated object cannot be changed
constant falseNot protectedAssociated object can be changed

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/protect_maintenance/',auth=auth,headers=headers,json=True)

Sample curl read command:

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

true

Browse more samples

Protect notification settings

sum (variant)config/protect_notification/
Protect notification settings from being modified
dot_inline_dotgraph_330.png

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 trueProtectedAssociated object cannot be changed, and its security-related parameters cannot be read
constant falseNot protectedAssociated object can be changed, and its security-related parameters can be read
constant "sender"Protect sender configurationAssociated 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 curl read command:

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

false

Sample uom library write command:

uom.config.protect_notification=true

Browse more samples

Beep on upgrade

sum (boolean)config/upgrade_notify_beep/
Indicate firmware upgrade progress by beeping
dot_inline_dotgraph_331.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample uom library write command:

uom.config.upgrade_notify_beep=false

Sample uom library read command:

print(uom.dump(uom.config.upgrade_notify_beep))

true

Browse more samples

Blink on upgrade

sum (boolean)config/upgrade_notify_blink/
Indicate firmware upgrade progress by blinking
dot_inline_dotgraph_332.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample CLI read command:

uom get "config/upgrade_notify_blink"

true

Sample JS request write command:

request.put({url:"config/upgrade_notify_blink/",body:true});

Browse more samples

Known quantities

mapconfig/known_quantities/
Map of known physical quantities
dot_inline_dotgraph_333.png

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 CLI read command:

uom get "config/known_quantities"

...

Sample curl read command:

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

...

Browse more samples

Quantity

objectconfig/known_quantities/S/
Physical quantity
dot_inline_dotgraph_334.png

This object contains the following items:

nameName
unitsKnown units
preferred_unitPreferred unit, if any

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

request.put({url:"config/known_quantities/"+_quantity+"/",body:{"preferred_unit":null,"name":"Voltage","units":{"V":{"offset":0,"internal":false,"name":"volt","scale":1}}}});

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

print(uom.dump(uom.config.known_quantities[_quantity]))

{name="Ratio",preferred_unit="times",units={["%"]={internal=true,name="percent",offset=0,scale=100},times={internal=true,name="",offset=0,scale=1}}}

Browse more samples

See also Quantity: Name

See also Quantity: Known units

See also Quantity: Preferred unit, if any

Quantity: Name

stringconfig/known_quantities/S/name/
Quantity name

This string does not support direct modification.

This string represents a value in persistent storage.

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

uom get "config/known_quantities/${quantity}/name"

"Energy"

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

print(uom.dump(uom.config.known_quantities[_quantity].name))

"Ratio"

Browse more samples

Quantity: Known units

mapconfig/known_quantities/S/units/
Map of known units for quantity
dot_inline_dotgraph_335.png

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 CLI unit creation command (note that quantity is a variable):

uom insert "config/known_quantities/${quantity}/units/s" "{\"offset\":0,\"name\":\"second\",\"scale\":1}"

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

print(uom.dump(uom.config.known_quantities[_quantity].units))

{["%"]={internal=true,name="percent",offset=0,scale=100},times={internal=true,name="",offset=0,scale=1}}

Browse more samples

Unit

objectconfig/known_quantities/S/units/S/
Unit of physical quantity
dot_inline_dotgraph_336.png

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:

nameName
scaleScaling factor
offsetOffset
internalInternal

Sample CLI write command (note that quantity and unit are variables):

uom set "config/known_quantities/${quantity}/units/${unit}" "{\"offset\":0,\"name\":\"percent\",\"scale\":100}"

Sample JS request write command (note that _quantity and _unit are variables):

request.put({url:"config/known_quantities/"+_quantity+"/units/"+_unit+"/",body:{"offset":0,"internal":false,"name":"kilowatt-hour","scale":2.77777778e-07}});

Browse more samples

Name

stringconfig/known_quantities/S/units/S/name/
Unit name
dot_inline_dotgraph_337.png

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 requests write command (note that _quantity and _unit are variables):

requests.put('http://192.168.0.100/restapi/config/known_quantities/'+_quantity+'/units/'+_unit+'/name/',auth=auth,headers=headers,json='')

Sample JS request write command (note that _quantity and _unit are variables):

request.put({url:"config/known_quantities/"+_quantity+"/units/"+_unit+"/name/",body:"ampere"});

Browse more samples

Scaling factor

numberconfig/known_quantities/S/units/S/scale/
Scaling factor for conversion from standard SI unit
dot_inline_dotgraph_338.png

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

print(uom.dump(uom.config.known_quantities[_quantity].units[_unit].scale))

2.77777778e-07

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)

Browse more samples

Offset

numberconfig/known_quantities/S/units/S/offset/
Offset for conversion from standard SI unit
dot_inline_dotgraph_339.png

Changing the value is denied if not administrative user

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

This number does not support direct modification if internal.

This number represents a value in persistent storage.

Sample requests write command (note that _quantity and _unit are variables):

requests.put('http://192.168.0.100/restapi/config/known_quantities/'+_quantity+'/units/'+_unit+'/offset/',auth=auth,headers=headers,json=0)

Sample requests read command (note that _quantity and _unit are variables):

print(requests.get('http://192.168.0.100/restapi/config/known_quantities/'+_quantity+'/units/'+_unit+'/offset/',auth=auth,headers=headers).json())

-459.67

Browse more samples

Internal

sum (boolean)config/known_quantities/S/units/S/internal/
Flag indicating whether this measurement unit is internal

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

This sum does not support direct modification.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueInternalThis unit is internal and cannot be modified
constant falseUserThis 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 requests read command (note that _quantity and _unit are variables):

print(requests.get('http://192.168.0.100/restapi/config/known_quantities/'+_quantity+'/units/'+_unit+'/internal/',auth=auth,headers=headers).json())

True

Browse more samples

Quantity: Preferred unit, if any

sum (optional string)config/known_quantities/S/preferred_unit/
Default UI unit for quantity, if any
dot_inline_dotgraph_340.png

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 nullStandard unitUI shows quantity in SI units
stringPreferred unitDefault UI unit for quantityknown units[the value]

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

"times"

Sample curl write command (note that :quantity 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/known_quantities/:quantity/preferred_unit/"

Browse more samples

Known timezones

mapconfig/known_timezones/
Map of known time zones
dot_inline_dotgraph_341.png

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map represents a value in persistent storage.

This map contains Timezone elements.

Creating elements in this collection is not supported.

Sample CLI read command:

uom get "config/known_timezones"

Sample uom library read command:

print(uom.dump(uom.config.known_timezones))

Browse more samples

Timezone

stringconfig/known_timezones/S/
Time zone name
dot_inline_dotgraph_342.png

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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+3"

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

print(uom.dump(uom.config.known_timezones[_timezone]))

"UTC-12"

Browse more samples

Known protection bits

mapconfig/known_protection_bits/
Map of known protection bits
dot_inline_dotgraph_343.png

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains 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 requests read command:

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

Browse more samples

See also Known protection bits: Protection bit

Known protection bits: Protection bit

objectconfig/known_protection_bits/S/
Protection bit properties
dot_inline_dotgraph_344.png

Retrieving the value is denied if not administrative user

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

This object contains the following items:

nameName
statusProtection status

Sample requests write command (note that _protection_bit is a variable):

requests.put('http://192.168.0.100/restapi/config/known_protection_bits/'+_protection_bit+'/',auth=auth,headers=headers,json={'name': 'Private configuration protection', 'status': True})

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

uom.config.known_protection_bits[_protection_bit]={name="Network settings protection",status="You have enabled that and that service which allows to bypass this protection"}

Browse more samples

Name

stringconfig/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 JS request read command (note that _protection_bit is a variable):

request.get({url:"config/known_protection_bits/"+_protection_bit+"/name/"},function(error,response,body) {console.log(body)});

"Network settings protection"

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

print(requests.get('http://192.168.0.100/restapi/config/known_protection_bits/'+_protection_bit+'/name/',auth=auth,headers=headers).json())

'Maintenance mode lock'

Browse more samples

Protection status

sum (variant)config/known_protection_bits/S/status/
Status of protection
dot_inline_dotgraph_345.png

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

This sum can 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 trueEnabledProtection is enabled and effective
constant falseDisabledProtection is disabled
stringIneffectiveProtection is enabled, but not effective for the following reason

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

print(uom.dump(uom.config.known_protection_bits[_protection_bit].status))

"You have enabled that and that service which allows to bypass this 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/status/"

"You have enabled that and that service which allows to bypass this protection"

Browse more samples

Relay ports

arrayconfig/relay_ports/
List of devices to which relay modules are connected
dot_inline_dotgraph_346.png

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 CLI read command:

uom get "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']

Browse more samples

Relay port

stringconfig/relay_ports/N/
Filename of a relay module device
dot_inline_dotgraph_347.png

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

print(requests.get('http://192.168.0.100/restapi/config/relay_ports/'+str(_relay_port_index)+'/',auth=auth,headers=headers).json())

'ttyATH0'

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

uom get "config/relay_ports/${relay_port_index}"

"ttyATH0"

Browse more samples