Configuration server object

object	config/
Object representing configuration server

This object contains the following items:

links	Links list
plots	Plots list
meters	Meters list
contact	Primary unit contact
contacts	Related contacts
location	Unit location
oid	Model OID
version	Version number
hardware_id	Hardware ID
serial	Serial number
outlet_label	Outlet label
brand_company_name	Brand company name
brand_name	Brand name
brand_url	Brand URL
brand_manual_url	Brand manual URL
brand_faq_url	Brand FAQ URL
brand_product_info_url	Brand product information URL
support_email	Support email
register_url	Registration URL
support_url	Support URL
update_url	Update URL
custom_brand_company_name	Custom brand company name, if any
custom_brand_name	Custom brand name, if any
custom_brand_url	Custom brand URL, if any
custom_brand_logo	Custom brand logo URL, if any
custom_brand_logo_width	Custom brand logo width, if any
custom_brand_logo_height	Custom brand logo height, if any
custom_support_email	Custom support email, if any
custom_register_url	Custom registration URL, if any
custom_support_url	Custom support URL, if any
custom_update_url	Custom update URL, if any
custom_help_url	Custom help URL, if any
customization_status	Customization status
registration_status	Registration status
refresh_enabled	Enable page refresh
refresh_delay_minutes	Page refresh delay
image_format	Preferred image format
hostname	Unit hostname
timezone	Time zone
http_ports	HTTP ports
https_ports	HTTPS ports
https_cert	HTTPS certificate settings
certificates	Certificate collection
crls	Certificate revocation list collection
ssh_enabled	SSH enabled
ssh_port	SSH port number
ssh_authorized_keys	SSH authorized keys
ntp_server_enabled	NTP server enabled
ntp_peers	NTP peers
syslog_minimal_severity	Syslog threshold severity
syslog_ip_address	Syslog server address, if any
allow_jsonrpc	Allow JSON-RPC
allow_jsonrpc_nonadmin	Allow non-administrative users to perform JSON-RPC requests
allow_restapi	Allow REST-like API
allow_restapi_nonadmin	Allow non-administrative users to access REST-like API
allow_restapi_origins	Allowed REST-like API client origins
allow_coapws	Allow CoAP over WebSockets
allow_coapws_nonadmin	Allow non-administrative users to access CoAP over WebSockets
allow_coapws_origins	Allowed CoAP over WebSockets client origins
relax_nonhtml_methods	Relax non-HTML method CSRF checks
relax_nonhtml_content_types	Relax non-HTML content type CSRF checks
allow_plaintext_logins	Allow plaintext logins
allow_modifying_get	Allow state-changing GET requests
name_always_visible	Relay name visibility
hide_passwords	Hide user passwords
hide_wifi_key	Hide WiFi key
lockout_delay_minutes	Security lockout duration
protect_firmware	Protect firmware
protect_admin	Protect admin login
protect_network	Protect network settings
protect_private_config	Protect private settings
protect_restore	Protect from restore
protect_maintenance	Protect from maintenance
protect_notification	Protect notification settings
upgrade_notify_beep	Beep on upgrade
upgrade_notify_blink	Blink on upgrade
known_quantities	Known quantities
known_timezones	Known timezones
known_protection_bits	Known protection bits
relay_ports	Relay ports

Sample CLI read command:

uom get config

⇒

...

Sample CLI write command:

uom set config ...

Browse more samples

Links list

array	config/links/
List of user-defined links to display in the web UI

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This array represents a value in persistent storage.

This array contains Link elements.

Sample JS request link creation command:

request.post({url:"config/links/",body:{"description":"test 5","href":"test_url7"}});

Sample JS request read command:

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

⇒

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

Browse more samples

See also Links list: Link

Links list: Link

object	config/links/N/
User-defined link

Retrieving the value is denied if not administrative user

This object represents a value in persistent storage.

This object contains the following items:

href	URI
description	Description

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

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

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

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

Browse more samples

URI

string	config/links/N/href/
The target URI of the link

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

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

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

request.put({url:"config/links/"+_link_index.toString()+"/href/",body:"test_url7"});

Browse more samples

Description

string	config/links/N/description/
The textual representation of the link

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

uom.config.links[_link_index].description="test 5"

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

request.get({url:"config/links/"+_link_index.toString()+"/description/"},function(error,response,body) {console.log(body)});

⇒

"test 3"

Browse more samples

Plots list

array	config/plots/
List of plots to display in the web UI

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This array represents a value in persistent storage.

This array contains Plot elements.

Sample JS request plot creation command:

request.post({url:"config/plots/",body:{"x2":{"min":null,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null},"y2":{"min":null,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null},"data":[{"ds":"environment.illuminance","style":{"type":"solid","style":"lines","width":1,"color":"FF0000","axes":"x1y1","marker":"plus","size":0},"title":"Illuminance"}],"width":640,"title":"Illuminance","display":false,"y1":{"min":0,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null},"x1":{"min":null,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null},"height":480}});

Sample requests read command:

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

⇒

<...>

Browse more samples

Plot

object	config/plots/N/
Configuration of plot for measured values

This object contains the following items:

title	Title
display	Display
width	Width
height	Height
x1	X1 axis settings
x2	X2 axis settings
y1	Y1 axis settings
y2	Y2 axis settings
data	Plot lines

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

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"x2\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"y2\":{\"min\":0,\"softmax\":1,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"data\":[{\"ds\":\"buses.1.voltage\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"FF0000\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size\":0},\"title\":\"Bus B voltage\"},{\"ds\":\"buses.1.current\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"0000FF\",\"axes\":\"x1y2\",\"marker\":\"plus\",\"size\":0},\"title\":\"Bus B current\"}],\"width\":640,\"title\":\"Bus B status\",\"display\":true,\"y1\":{\"min\":0,\"softmax\":110,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"x1\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"height\":480}" "http://192.168.0.100/restapi/config/plots/:plot_index/"

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

request.delete({url:"config/plots/"+_plot_index.toString()+"/"});

Browse more samples

See also Plot: Title

See also Plot: Display

See also Plot: Width

See also Plot: Height

See also Plot: X1 axis settings

See also Plot: X2 axis settings

See also Plot: Y1 axis settings

See also Plot: Y2 axis settings

See also Plot: Plot lines

Plot: Title

string	config/plots/N/title/
The title of the plot

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"Bus B status\"" "http://192.168.0.100/restapi/config/plots/:plot_index/title/"

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

request.put({url:"config/plots/"+_plot_index.toString()+"/title/",body:"Relay voltage"});

Browse more samples

Plot: Display

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Shown	The plot is shown
constant false	Hidden	The plot is hidden

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

uom set "config/plots/${plot_index}/display" "true"

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

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

⇒

True

Browse more samples

Plot: Width

number	config/plots/N/width/
The width of the plot

The value represents screen length, the standard unit of which is the pixel (px).

The value is subject to the following constraints: all of the following is true:

• the value is an integer
• the value is greater than 0

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

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

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "640" "http://192.168.0.100/restapi/config/plots/:plot_index/width/"

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

request.put({url:"config/plots/"+_plot_index.toString()+"/width/",body:640});

Browse more samples

Plot: Height

number	config/plots/N/height/
The height of the plot

The value represents screen length, the standard unit of which is the pixel (px).

The value is subject to the following constraints: all of the following is true:

• the value is an integer
• the value is greater than 0

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

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

uom.config.plots[_plot_index].height=480

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

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

Browse more samples

Plot: X1 axis settings

object	config/plots/N/x1/
Configuration for X1 axis

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This object represents a value in persistent storage.

This object contains the following items:

min	Minimum, if any
max	Maximum, if any
softmin	Soft minimum, if any
softmax	Soft maximum, if any
tics	Major tick interval, if any
mtics	Minor ticks per major tick, if any

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

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

⇒

{'min': None, 'softmax': None, 'max': None, 'tics': None, 'mtics': None, 'softmin': None}

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

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

⇒

{"min":null,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null}

Browse more samples

Minimum, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The maximum value is derived from data and the soft maximum
number	Minimum	Minimum value to display on the axis

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/plots/:plot_index/x1/min/"

⇒

null

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

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

⇒

null

Browse more samples

Maximum, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The minimum value is derived from data and the soft minimum
number	Maximum	Maximum value to display on the axis

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

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

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

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

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	No soft maximum defined
number	Soft minimum	Minimum value to display on the axis unless values exist below it

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

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

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

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

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	No soft minimum defined
number	Soft maximum	Maximum value to display on the axis unless values exist above it

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

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

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

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

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The tick interval is derived from data and size
number	Major tick interval	The interval, in value units, between major ticks of the axis

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

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

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

uom set "config/plots/${plot_index}/x1/tics" "null"

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	There are no minor ticks
number	Minor ticks per major tick	The number of minor ticks between two major ticks	all of the following is true: the value is an integer the value is greater or equal to 0

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

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

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

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

Browse more samples

Plot: X2 axis settings

object	config/plots/N/x2/
Configuration for X2 axis

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This object represents a value in persistent storage.

This object contains the following items:

min	Minimum, if any
max	Maximum, if any
softmin	Soft minimum, if any
softmax	Soft maximum, if any
tics	Major tick interval, if any
mtics	Minor ticks per major tick, if any

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

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

⇒

{'min': None, 'softmax': None, 'max': None, 'tics': None, 'mtics': None, 'softmin': None}

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

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

⇒

{"min":null,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null}

Browse more samples

Minimum, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The maximum value is derived from data and the soft maximum
number	Minimum	Minimum value to display on the axis

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

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

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/plots/:plot_index/x2/min/"

⇒

null

Browse more samples

Maximum, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The minimum value is derived from data and the soft minimum
number	Maximum	Maximum value to display on the axis

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

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

⇒

null

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

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

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	No soft maximum defined
number	Soft minimum	Minimum value to display on the axis unless values exist below it

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

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

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

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

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	No soft minimum defined
number	Soft maximum	Maximum value to display on the axis unless values exist above it

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

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

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

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

⇒

null

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The tick interval is derived from data and size
number	Major tick interval	The interval, in value units, between major ticks of the axis

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

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

⇒

None

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

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

⇒

null

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	There are no minor ticks
number	Minor ticks per major tick	The number of minor ticks between two major ticks	all of the following is true: the value is an integer the value is greater or equal to 0

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

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

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

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

Browse more samples

Plot: Y1 axis settings

object	config/plots/N/y1/
Configuration for Y1 axis

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This object represents a value in persistent storage.

This object contains the following items:

min	Minimum, if any
max	Maximum, if any
softmin	Soft minimum, if any
softmax	Soft maximum, if any
tics	Major tick interval, if any
mtics	Minor ticks per major tick, if any

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

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

⇒

{"min":0,"softmax":null,"max":null,"tics":null,"mtics":null,"softmin":null}

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

requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/y1/',auth=auth,headers=headers,json={'min': None, 'softmax': None, 'max': None, 'tics': None, 'mtics': None, 'softmin': None})

Browse more samples

Minimum, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The maximum value is derived from data and the soft maximum
number	Minimum	Minimum value to display on the axis

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

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

⇒

0

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

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

⇒

None

Browse more samples

Maximum, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The minimum value is derived from data and the soft minimum
number	Maximum	Maximum value to display on the axis

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

uom.config.plots[_plot_index].y1.max=null

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

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

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	No soft maximum defined
number	Soft minimum	Minimum value to display on the axis unless values exist below it

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

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

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

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

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	No soft minimum defined
number	Soft maximum	Maximum value to display on the axis unless values exist above it

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

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

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

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

⇒

null

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The tick interval is derived from data and size
number	Major tick interval	The interval, in value units, between major ticks of the axis

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

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

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

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

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	There are no minor ticks
number	Minor ticks per major tick	The number of minor ticks between two major ticks	all of the following is true: the value is an integer the value is greater or equal to 0

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

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

⇒

null

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/plots/:plot_index/y1/mtics/"

⇒

null

Browse more samples

Plot: Y2 axis settings

object	config/plots/N/y2/
Configuration for Y2 axis

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This object represents a value in persistent storage.

This object contains the following items:

min	Minimum, if any
max	Maximum, if any
softmin	Soft minimum, if any
softmax	Soft maximum, if any
tics	Major tick interval, if any
mtics	Minor ticks per major tick, if any

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

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

⇒

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

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

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

Browse more samples

Minimum, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The maximum value is derived from data and the soft maximum
number	Minimum	Minimum value to display on the axis

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

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

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

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

Browse more samples

Maximum, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The minimum value is derived from data and the soft minimum
number	Maximum	Maximum value to display on the axis

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

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

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

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

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	No soft maximum defined
number	Soft minimum	Minimum value to display on the axis unless values exist below it

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

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

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

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

⇒

None

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	No soft minimum defined
number	Soft maximum	Maximum value to display on the axis unless values exist above it

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

print(uom.dump(uom.config.plots[_plot_index].y2.softmax))

⇒

1

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

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

⇒

1

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Automatic	The tick interval is derived from data and size
number	Major tick interval	The interval, in value units, between major ticks of the axis

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/plots/:plot_index/y2/tics/"

⇒

null

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

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

Browse more samples

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	There are no minor ticks
number	Minor ticks per major tick	The number of minor ticks between two major ticks	all of the following is true: the value is an integer the value is greater or equal to 0

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

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

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

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

Browse more samples

Plot line configuration: Style

object	config/plots/N/data/N/style/
Style of the plot line

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This object represents a value in persistent storage.

This object contains the following items:

style	Line style
type	Line type
color	Line color
width	Line width
marker	Marker type
size	Marker size
axes	Base axes

Sample curl write command (note that :plot_index and :plot_line_configuration_index are URL template arguments):

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"FF0000\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size\":0}" "http://192.168.0.100/restapi/config/plots/:plot_index/data/:plot_line_configuration_index/style/"

Sample CLI read command (note that plot_index and plot_line_configuration_index are variables):

uom get "config/plots/${plot_index}/data/${plot_line_configuration_index}/style"

⇒

{"type":"solid","style":"lines","width":1,"color":"FF0000","axes":"x1y1","marker":"plus","size":0}

Browse more samples

Line style

string	config/plots/N/data/N/style/style/
The style of the line

The value is subject to the following constraints: plot styles[the value]

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

This string represents a value in persistent storage.

Sample curl read command (note that :plot_index and :plot_line_configuration_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/plots/:plot_index/data/:plot_line_configuration_index/style/style/"

⇒

"lines"

Sample curl write command (note that :plot_index and :plot_line_configuration_index are URL template arguments):

curl --digest -u admin:1234 -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

string	config/plots/N/data/N/style/type/
The type of the line

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

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

This string represents a value in persistent storage.

Sample uom library 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.type))

⇒

"solid"

Sample uom library write command (note that _plot_index and _plot_line_configuration_index are variables):

uom.config.plots[_plot_index].data[_plot_line_configuration_index].style.type="solid"

Browse more samples

Line color

string	config/plots/N/data/N/style/color/
The color of the line

The value is subject to the following constraints: the value matches ^[0-9A-F]{6}$

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

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

Sample uom library write command (note that _plot_index and _plot_line_configuration_index are variables):

uom.config.plots[_plot_index].data[_plot_line_configuration_index].style.color="FF0000"

Browse more samples

Line width

number	config/plots/N/data/N/style/width/
The width of the line

The value represents screen length, the standard unit of which is the pixel (px).

The value is subject to the following constraints: all of the following is true:

• the value is an integer
• the value is greater or equal to 0

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This number represents a value in persistent storage.

Sample curl read command (note that :plot_index and :plot_line_configuration_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/plots/:plot_index/data/:plot_line_configuration_index/style/width/"

⇒

1

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

⇒

1

Browse more samples

Marker type

string	config/plots/N/data/N/style/marker/
The type of the marker

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

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

This string represents a value in persistent storage.

Sample curl write command (note that :plot_index and :plot_line_configuration_index are URL template arguments):

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"plus\"" "http://192.168.0.100/restapi/config/plots/:plot_index/data/:plot_line_configuration_index/style/marker/"

Sample curl read command (note that :plot_index and :plot_line_configuration_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/plots/:plot_index/data/:plot_line_configuration_index/style/marker/"

⇒

"plus"

Browse more samples

Marker size

number	config/plots/N/data/N/style/size/
The size of the markers

The value represents screen length, the standard unit of which is the pixel (px).

The value is subject to the following constraints: all of the following is true:

• the value is an integer
• the value is greater or equal to 0

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This number represents a value in persistent storage.

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

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

Sample uom library write command (note that _plot_index and _plot_line_configuration_index are variables):

uom.config.plots[_plot_index].data[_plot_line_configuration_index].style.size=0

Browse more samples

Base axes

string	config/plots/N/data/N/style/axes/
The axes on which the line should be plotted. Units of lines plotted on the same axes must match

The value is subject to the following constraints: axes[the value]

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

This string represents a value in persistent storage.

Sample CLI read command (note that plot_index and plot_line_configuration_index are variables):

uom get "config/plots/${plot_index}/data/${plot_line_configuration_index}/style/axes"

⇒

"x1y1"

Sample requests read command (note that _plot_index and _plot_line_configuration_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'

Browse more samples

Plot: Plot lines

array	config/plots/N/data/
Configurations of values to plot

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

This array contains Plot line configuration elements.

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

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

⇒

[{"ds":"power_voltage","style":{"type":"solid","style":"lines","width":1,"color":"FF0000","axes":"x1y1","marker":"plus","size":0},"title":"Power voltage"}]

Sample curl plot line configuration creation command (note that :plot_index is a URL template argument):

curl --digest -u admin:1234 -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"ds\":\"environment.temperature\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"FF0000\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size\":0},\"title\":\"Temperature\"}" "http://192.168.0.100/restapi/config/plots/:plot_index/data/"

Browse more samples

Plot line configuration

object	config/plots/N/data/N/
Properties of a plot line

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

This object contains the following items:

ds	Data source
title	Title
style	Style

Sample CLI 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","style":{"type":"solid","style":"lines","width":1,"color":"FF0000","axes":"x1y1","marker":"plus","size":0},"title":"Relay voltage"}

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

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

⇒

{"ds":"environment.illuminance","style":{"type":"solid","style":"lines","width":1,"color":"FF0000","axes":"x1y1","marker":"plus","size":0},"title":"Illuminance"}

Browse more samples

Data source

string	config/plots/N/data/N/ds/
Identifier of the data source to use

The value is subject to the following constraints: measured values[the value]

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

⇒

"buses.1.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" "\"environment.illuminance\""

Browse more samples

Title

string	config/plots/N/data/N/title/
The title of the plot line

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This string represents a value in persistent storage.

Sample 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].title))

⇒

"Bus B current"

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

⇒

'Temperature'

Browse more samples

See also Plot line configuration: Style

Meters list

array	config/meters/
List of meters to display in the web UI

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This array represents a value in persistent storage.

This array contains Meter configuration elements.

Sample CLI write command:

uom set "config/meters" ...

Sample JS request read command:

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

⇒

<...>

Browse more samples

Meter configuration

object	config/meters/N/
Configuration of meter for a measured value

This object contains the following items:

title	Title
display	Display
data	Data source
width	Width
height	Height
scale	Display scale
decimals	Decimals
color	Arrow color
min_value	Minimum value
sectors	Meter sectors

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

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

⇒

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

requests.put('http://192.168.0.100/restapi/config/meters/'+str(_meter_configuration_index)+'/',auth=auth,headers=headers,json={'decimals': 0, 'color': '', 'sectors': [{'color': '0000FF', 'name': 'Low', 'value': 100}, {'color': '00FF00', 'name': 'Optimal', 'value': 127}, {'color': 'FF0000', 'name': 'High', 'value': 140}], 'data': 'buses.1.voltage', 'width': 128, 'title': 'Bus B voltage', 'display': False, 'min_value': 90, 'scale': 'linear', 'height': 64})

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

string	config/meters/N/title/
The title of the meter

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"Illuminance\"" "http://192.168.0.100/restapi/config/meters/:meter_configuration_index/title/"

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

requests.put('http://192.168.0.100/restapi/config/meters/'+str(_meter_configuration_index)+'/title/',auth=auth,headers=headers,json='Bus B voltage')

Browse more samples

Meter configuration: Display

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Shown	The meter is shown
constant false	Hidden	The meter is hidden

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

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

⇒

true

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

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

Browse more samples

Meter configuration: Data source

string	config/meters/N/data/
Identifier of the data source to use

The value is subject to the following constraints: measured values[the value]

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

requests.put('http://192.168.0.100/restapi/config/meters/'+str(_meter_configuration_index)+'/data/',auth=auth,headers=headers,json='environment.illuminance')

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

uom.config.meters[_meter_configuration_index].data="battery_voltage"

Browse more samples

Meter configuration: Width

number	config/meters/N/width/
The width of the meter

The value represents screen length, the standard unit of which is the pixel (px).

The value is subject to the following constraints: all of the following is true:

• the value is an integer
• the value is greater than 0

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

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

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

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

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

⇒

128

Browse more samples

Meter configuration: Height

number	config/meters/N/height/
The height of the meter

The value represents screen length, the standard unit of which is the pixel (px).

The value is subject to the following constraints: all of the following is true:

• the value is an integer
• the value is greater than 0

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

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

requests.put('http://192.168.0.100/restapi/config/meters/'+str(_meter_configuration_index)+'/height/',auth=auth,headers=headers,json=64)

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

uom set "config/meters/${meter_configuration_index}/height" "64"

Browse more samples

Meter configuration: Display scale

string	config/meters/N/scale/
The scale function to use for display

The value is subject to the following constraints: plot scales[the value]

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

uom.config.meters[_meter_configuration_index].scale="linear"

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

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

⇒

"linear"

Browse more samples

Meter configuration: Decimals

number	config/meters/N/decimals/
Number of decimal places to show in displayed value

The value represents count, the standard unit of which is the time (times).

The value is subject to the following constraints: all of the following is true:

• the value is an integer
• the value is greater or equal to 0

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

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

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

⇒

1

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

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

⇒

2

Browse more samples

Meter configuration: Arrow color

string	config/meters/N/color/
The color of the meter arrow

The value is subject to the following constraints: the value matches ^[0-9A-F]{6}$

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

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

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

uom.config.meters[_meter_configuration_index].color=""

Browse more samples

Meter configuration: Minimum value

number	config/meters/N/min_value/
The minimum value to be displayed on the meter

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

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

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "0" "http://192.168.0.100/restapi/config/meters/:meter_configuration_index/min_value/"

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

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

Browse more samples

Meter configuration: Meter sectors

array	config/meters/N/sectors/
Configuration of meter sectors

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This array represents a value in persistent storage.

This array contains Sector configuration elements.

Sample CLI sector configuration creation command (note that meter_configuration_index is a variable):

uom insert "config/meters/${meter_configuration_index}/sectors/1" "{\"color\":\"00FF00\",\"name\":\"Optimal\",\"value\":5.5}"

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

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

⇒

[{"color":"00FF00","name":"Optimal","value":12},{"color":"FF0000","name":"High","value":15}]

Browse more samples

Sector configuration

object	config/meters/N/sectors/N/
Configuration of a meter sector

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

This object contains the following items:

name	Name
value	Maximum value
color	Color

Sample curl write command (note that :meter_configuration_index and :sector_configuration_index are URL template arguments):

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"color\":\"0000FF\",\"name\":\"Low\",\"value\":100}" "http://192.168.0.100/restapi/config/meters/:meter_configuration_index/sectors/:sector_configuration_index/"

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

uom.config.meters[_meter_configuration_index].sectors[_sector_configuration_index]={color="00FF00",name="Optimal",value=12}

Browse more samples

Name

string	config/meters/N/sectors/N/name/
The name of the sector

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

print(uom.dump(uom.config.meters[_meter_configuration_index].sectors[_sector_configuration_index].name))

⇒

"High"

Sample JS request write command (note that _meter_configuration_index and _sector_configuration_index are variables):

request.put({url:"config/meters/"+_meter_configuration_index.toString()+"/sectors/"+_sector_configuration_index.toString()+"/name/",body:"Cold"});

Browse more samples

Maximum value

number	config/meters/N/sectors/N/value/
The maximum value for the sector

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This number represents a value in persistent storage.

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

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

⇒

10000

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

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

Browse more samples

Color

string	config/meters/N/sectors/N/color/
The color of the sector

The value is subject to the following constraints: the value matches ^[0-9A-F]{6}$

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This string represents a value in persistent storage.

Sample curl write command (note that :meter_configuration_index and :sector_configuration_index are URL template arguments):

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"00FF00\"" "http://192.168.0.100/restapi/config/meters/:meter_configuration_index/sectors/:sector_configuration_index/color/"

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

uom.config.meters[_meter_configuration_index].sectors[_sector_configuration_index].color="00FF00"

Browse more samples

Primary unit contact

string	config/contact/
The person or entity responsible for this unit and information on how to contact them

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample JS request read command:

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

⇒

"support@example.com"

Sample uom library write command:

uom.config.contact="support@example.com"

Browse more samples

Related contacts

map	config/contacts/
Contacts related to the unit in different ways

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map represents a value in persistent storage.

This map contains Contact elements.

Sample uom library contact creation command:

uom.insert(uom.config.contacts,"sales",{email="sales@foo.example.com",fax=null,name="Sales",phone="+10628316379574"})

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/contacts/',auth=auth,headers=headers,json={'engineering': {'phone': '+08670733114697', 'fax': None, 'name': 'Engineering', 'email': 'engineering@baz.example.com'}, 'sales': {'phone': None, 'fax': '+6887116106248', 'name': 'Sales', 'email': 'sales@bar.example.com'}, 'support': {'phone': None, 'fax': None, 'name': 'Support', 'email': None}, 'security': {'phone': '+7105471557265', 'fax': None, 'name': 'Security', 'email': None}})

Browse more samples

See also Related contacts: Contact

Related contacts: Contact

object	config/contacts/S/
Contact properties

The value is subject to the following constraints: not index of the value matches ^(|$.*)$

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This object represents a value in persistent storage.

This object contains the following items:

name	Name
email	Email, if any
phone	Phone number, if any
fax	Fax number, if any

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

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

⇒

{email="sales@foo.example.com",fax="+644750733356319",name="Sales",phone="+35891072446560"}

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

request.put({url:"config/contacts/"+_contact+"/",body:{"phone":"+495323019323612","fax":"+96344370461855","name":"Features","email":null}});

Browse more samples

Name

string	config/contacts/S/name/
Contact name

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

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

⇒

"Sales"

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

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

⇒

'Engineering'

Browse more samples

Email, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	No email address stored
string	Email	Contact email address	the value is not equal to ""

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

uom.config.contacts[_contact].email=null

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

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

⇒

"engineering@foo.example.com"

Browse more samples

Phone number, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	No phone number stored
string	Phone number	Contact phone number	the value is not equal to ""

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

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

⇒

"+155889651719849"

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

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

⇒

null

Browse more samples

Fax number, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	No fax number stored
string	Fax number	Contact fax number	the value is not equal to ""

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

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

⇒

None

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

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

⇒

null

Browse more samples

Unit location

string	config/location/
The physical location of this unit (e.g. '1st floor, rack 9')

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample JS request read command:

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

⇒

"Server room"

Sample CLI write command:

uom set "config/location" "\"Server room\""

Browse more samples

Model OID

string	config/oid/
Object identifier of unit model (should be registered under dliRegistration OID)

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample curl read command:

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

⇒

"1.3.6.1.4.1.45770.1.3"

Sample uom library read command:

print(uom.dump(uom.config.oid))

⇒

"1.3.6.1.4.1.45770.1.3"

Browse more samples

Version number

string	config/version/
Version number of frontend software

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample JS request read command:

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

⇒

"1.8.1.0"

Sample curl read command:

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

⇒

"1.8.1.0"

Browse more samples

Hardware ID

string	config/hardware_id/
Identifier of unit hardware model

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample curl read command:

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

⇒

"EPCR5"

Sample JS request read command:

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

⇒

"EPCR5"

Browse more samples

Serial number

string	config/serial/
Unit's serial number

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample requests read command:

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

⇒

'EPCR72203123456'

Sample uom library read command:

print(uom.dump(uom.config.serial))

⇒

"EPCR72203123456"

Browse more samples

Outlet label

string	config/outlet_label/
User-visible label for an outlet controlled by a relay

This string does not support direct modification.

This string represents a value in persistent storage.

Sample requests read command:

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

⇒

'Outlet'

Sample curl read command:

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

⇒

"Outlet"

Browse more samples

Brand company name

string	config/brand_company_name/
The name of the company which produced the device

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample CLI read command:

uom get "config/brand_company_name"

⇒

"Digital Loggers, Inc."

Sample JS request read command:

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

⇒

"Digital Loggers, Inc."

Browse more samples

Brand name

string	config/brand_name/
Default brand name, unless overridden

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample CLI read command:

uom get "config/brand_name"

⇒

"Ethernet Power Controller"

Sample JS request read command:

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

⇒

"Ethernet Power Controller"

Browse more samples

Brand URL

string	config/brand_url/
Default brand URL, unless overridden

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample uom library read command:

print(uom.dump(uom.config.brand_url))

⇒

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

Sample requests read command:

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

⇒

'https://bar.example.com/foo/foo/quux/quux.htm'

Browse more samples

Brand manual URL

string	config/brand_manual_url/
Brand product manual URL

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample JS request read command:

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

⇒

"https://baz.example.com:48443/foo.htm"

Sample requests read command:

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

⇒

'https://bar.example.com:443/bar.htm'

Browse more samples

Brand FAQ URL

string	config/brand_faq_url/
Brand product FAQ URL

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample requests read command:

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

⇒

'http://baz.example.com/bar/foo/foo.htm'

Sample CLI read command:

uom get "config/brand_faq_url"

⇒

"http://foo.example.com/quux/foo.html"

Browse more samples

Brand product information URL

string	config/brand_product_info_url/
Brand product information URL

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample curl read command:

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

⇒

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

Sample JS request read command:

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

⇒

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

Browse more samples

Support email

string	config/support_email/
Product support email

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

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

uom get "config/support_email"

⇒

"support@example.com"

Browse more samples

Registration URL

string	config/register_url/
Default registration URL, unless overridden

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample JS request read command:

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

⇒

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

Sample uom library read command:

print(uom.dump(uom.config.register_url))

⇒

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

Browse more samples

Support URL

string	config/support_url/
Default support URL, unless overridden

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample curl read command:

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

⇒

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

Sample requests read command:

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

⇒

'https://baz.example.com:443/foo/quux/quux/quux/quux/bar.htm'

Browse more samples

Update URL

string	config/update_url/
Default update URL, unless overridden

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample curl read command:

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

⇒

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

Sample CLI read command:

uom get "config/update_url"

⇒

"https://foo.example.com:18443/bar.htm"

Browse more samples

Custom brand company name, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• customization status is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Default	Use default brand company name
string	Custom brand company name	User-visible brand company name	the value is not equal to ""

Sample requests write command:

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

Sample CLI read command:

uom get "config/custom_brand_company_name"

⇒

"Whatever Systems Inc."

Browse more samples

Custom brand name, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• customization status is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Default	Use default product brand name
string	Custom brand name	User-visible product brand name	the value is not equal to ""

Sample CLI write command:

uom set "config/custom_brand_name" "\"Amazing Controller III\""

Sample JS request read command:

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

⇒

"Amazing Controller III"

Browse more samples

Custom brand URL, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• customization status is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Default	Use default brand URL
string	Custom brand URL	User-visible brand URL	the value is not equal to ""

Sample CLI read command:

uom get "config/custom_brand_url"

⇒

"https://bar.example.com:48443/baz/foo.htm"

Sample curl write command:

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

Browse more samples

Custom brand logo URL, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• customization status is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Default	Use default brand logo
string	Custom brand logo URL	User-visible brand logo URL	the value is not equal to ""

Sample requests write command:

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

Sample CLI read command:

uom get "config/custom_brand_logo"

⇒

"http://foo.example.com:8064/quux/foo/bar.svg"

Browse more samples

Custom brand logo width, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• customization status is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Default	Use default brand logo width
number	Custom brand logo width	User-visible brand logo width

Sample JS request write command:

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

Sample uom library write command:

uom.config.custom_brand_logo_width=22

Browse more samples

Custom brand logo height, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• customization status is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Default	Use default brand logo height
number	Custom brand logo height	User-visible brand logo height

Sample curl write command:

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "32" "http://192.168.0.100/restapi/config/custom_brand_logo_height/"

Sample CLI read command:

uom get "config/custom_brand_logo_height"

⇒

32

Browse more samples

Custom support email, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• customization status is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Default	Use default support email
string	Custom support email	User-visible product support email	the value is not equal to ""

Sample curl write command:

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"support@example.com\"" "http://192.168.0.100/restapi/config/custom_support_email/"

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/custom_support_email/',auth=auth,headers=headers,json='support@example.com')

Browse more samples

Custom registration URL, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• customization status is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Default	Use default registration URL
string	Custom registration URL	User-visible registration URL	the value is not equal to ""

Sample requests write command:

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

Sample uom library write command:

uom.config.custom_register_url="https://baz.example.com:443/quux/bar/bar.htm"

Browse more samples

Custom support URL, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• customization status is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Default	Use default support URL
string	Custom support URL	User-visible support URL	the value is not equal to ""

Sample CLI write command:

uom set "config/custom_support_url" "\"https://baz.example.com:18443/bar/baz/quux.html\""

Sample uom library read command:

print(uom.dump(uom.config.custom_support_url))

⇒

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

Browse more samples

Custom update URL, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• customization status is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Default	Use default update URL
string	Custom update URL	User-visible update URL	the value is not equal to ""

Sample curl write command:

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

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/custom_update_url/',auth=auth,headers=headers,json='https://bar.example.com/bar/bar.htm')

Browse more samples

Custom help URL, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• customization status is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Internal help	Use the internal embedded help system
string	Custom help URL	User-visible help URL	the value is not equal to ""

Sample uom library write command:

uom.config.custom_help_url="https://bar.example.com/foo/quux/baz/baz/quux/baz/bar/quux/quux/foo/quux.htm"

Sample JS request read command:

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

⇒

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

Browse more samples

Customization status

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• any of the following is true:
  • the value is equal to open
  • the value is equal to locked

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Default	Customization options can be changed and/or locked
constant "open"	Open	Customization options can be changed, but cannot be locked
constant "locked"	Locked	Customization options are locked and cannot be changed

Sample CLI read command:

uom get "config/customization_status"

⇒

null

Sample requests write command:

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

Browse more samples

Registration status

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Defined	The user has either registered the unit, or refused to do so
constant false	Undefined	The user hasn't decided on registering the unit and needs to be reminded

Sample uom library write command:

uom.config.registration_status=false

Sample uom library read command:

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

⇒

true

Browse more samples

Enable page refresh

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

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample requests write command:

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

Sample JS request read command:

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

⇒

true

Browse more samples

Page refresh delay

number	config/refresh_delay_minutes/
Status page refresh delay, if refresh is enabled

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

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

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample requests read command:

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

⇒

1

Sample uom library read command:

print(uom.dump(uom.config.refresh_delay_minutes))

⇒

1

Browse more samples

Preferred image format

string	config/image_format/
Default image format for plots and meters

The value is subject to the following constraints: image formats[the value]

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Sample uom library write command:

uom.config.image_format="jpg"

Sample requests write command:

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

Browse more samples

Unit hostname

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

The value is subject to the following constraints: the value matches ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]).)*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?)$

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample CLI write command:

uom set "config/hostname" "\"bar.example.com\""

Sample uom library write command:

uom.config.hostname="bar.example.com"

Browse more samples

Time zone

string	config/timezone/
System time zone

The value is subject to the following constraints: known timezones[the value]

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Sample requests write command:

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

Sample uom library read command:

print(uom.dump(uom.config.timezone))

⇒

"UTC"

Browse more samples

HTTP ports

array	config/http_ports/
HTTP port bindings

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This array represents a value in persistent storage.

This array represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).

Changes to this array do not take effect immediately.

This array contains Port binding elements.

Sample CLI read command:

uom get "config/http_ports"

⇒

[{"port":"80","address":"192.168.0.83"},{"port":"8007","address":"192.168.0.9"},{"port":"8020","address":"192.168.0.65"},{"port":"80","address":"192.168.0.5"},{"port":"80","address":"192.168.0.78"}]

Sample uom library write command:

uom.config.http_ports={{address="192.168.0.17",port="8088"},{address="192.168.0.92",port="80"},{address="192.168.0.99",port="8089"},{address="192.168.0.48",port="80"}}

Browse more samples

See also HTTP ports: Port binding

HTTP ports: Port binding

object	config/http_ports/N/
Address and port to bind service to

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This object represents a value in persistent storage.

Changes to this object do not take effect immediately.

This object contains the following items:

address	Address
port	Port

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

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

⇒

{"port":"8064","address":"192.168.0.72"}

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

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"port\":\"80\",\"address\":\"192.168.0.8\"}" "http://192.168.0.100/restapi/config/http_ports/:port_binding_index/"

Browse more samples

Address

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

string	IPv4 address	IPv4 address to listen on	the value matches ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
string	IPv6 address	IPv6 address to listen on	the value matches ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$

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

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

⇒

'192.168.0.13'

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

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

⇒

"192.168.0.2"

Browse more samples

Port

number	config/http_ports/N/port/
Port number to bind to

The value is subject to the following constraints: all of the following is true:

• the value is an integer
• the value is greater than 0
• the value is less than 65535

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This number represents a value in persistent storage.

Changes to this number do not take effect immediately.

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

uom.config.http_ports[_port_binding_index].port="8060"

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

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

⇒

'80'

Browse more samples

HTTPS ports

array	config/https_ports/
HTTPS port bindings

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This array represents a value in persistent storage.

This array represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).

Changes to this array do not take effect immediately.

This array contains Port binding elements.

Sample requests port binding creation command:

requests.post('http://192.168.0.100/restapi/config/https_ports/',auth=auth,headers=headers,json={'port': '8', 'address': '192.168.0.39'})

Sample curl port binding creation command:

curl --digest -u admin:1234 -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"port\":\"80\",\"address\":\"192.168.0.46\"}" "http://192.168.0.100/restapi/config/https_ports/"

Browse more samples

See also HTTPS ports: Port binding

HTTPS ports: Port binding

object	config/https_ports/N/
Address and port to bind service to

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This object represents a value in persistent storage.

Changes to this object do not take effect immediately.

This object contains the following items:

address	Address
port	Port

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

request.delete({url:"config/https_ports/"+_port_binding_index.toString()+"/"});

Sample curl deletion command (note that :port_binding_index is a URL template argument):

curl --digest -u admin:1234 -X DELETE -H "Accept: application/json" "http://192.168.0.100/restapi/config/https_ports/:port_binding_index/"

Browse more samples

Address

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

string	IPv4 address	IPv4 address to listen on	the value matches ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
string	IPv6 address	IPv6 address to listen on	the value matches ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-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 curl read command (note that :port_binding_index is a URL template argument):

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

⇒

"192.168.0.88"

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

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

Browse more samples

Port

number	config/https_ports/N/port/
Port number to bind to

The value is subject to the following constraints: all of the following is true:

• the value is an integer
• the value is greater than 0
• the value is less than 65535

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This number represents a value in persistent storage.

Changes to this number do not take effect immediately.

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

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

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

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"80\"" "http://192.168.0.100/restapi/config/https_ports/:port_binding_index/port/"

Browse more samples

HTTPS certificate settings

object	config/https_cert/
HTTPS certificate configuration

Retrieving the value is denied if not administrative user

This object contains the following items:

bits	Bits
distinguished_name	Distinguished name
string_mask	String mask
domains	Domain names override, if any
addresses	Addresses override, if any
automatic_renewal	Automatic renewal
renewal_method	Certificate renewal method
renewal_data	Data
csr	HTTPS certificate signing request, if it can be generated
cert	HTTPS certificate chain
key	HTTPS certificate key
renew_cert	Renew certificate
generate_key	Generate key
known_dn_oids	Known DN OIDs
known_renewal_methods	Renewal methods

Sample CLI write command:

uom set "config/https_cert" ...

Sample requests read command:

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

⇒

<...>

Browse more samples

Bits

number	config/https_cert/bits/
Size of new private keys

The value represents count, the standard unit of which is the time (times).

The value is subject to the following constraints: all of the following is true:

• the value is an integer
• the value is greater than 0

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This number represents a value in persistent storage.

Sample uom library read command:

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

⇒

1024

Sample curl write command:

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

Browse more samples

Distinguished name

map	config/https_cert/distinguished_name/
New certificate distinguished name elements

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This map represents a value in persistent storage.

This map contains Values elements.

Sample requests values creation command:

requests.put('http://192.168.0.100/restapi/config/https_cert/distinguished_name/commonName/',auth=auth,headers=headers,json=['Digital Loggers Unit'])

Sample curl write command:

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"commonName\":[\"Digital Loggers Unit\"],\"countryName\":[\"US\"],\"stateOrProvinceName\":[\"California\"],\"localityName\":[\"Santa Clara\"]}" "http://192.168.0.100/restapi/config/https_cert/distinguished_name/"

Browse more samples

See also Distinguished name: Values

String mask

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

This sum can assume the following values:

constant "default"	OpenSSL default	PrintableString, T61String and BMPString
constant "pkix"	PKIX	PrintableString and BMPString
constant "utf8only"	UTF-8 strings only	UTF8String
constant "nombstr"	No multibyte strings	PrintableString and T61String

Sample requests write command:

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

Sample requests read command:

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

⇒

'pkix'

Browse more samples

Domain names override, if any

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Use hostname	Certify for the current hostname when enrolling certificate
array	Domain names override	Explicit domain name list to certify for when enrolling certificate

Sample curl read command:

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

⇒

["bar.example.com","baz.example.com","baz.example.com"]

Sample JS request write command:

request.put({url:"config/https_cert/domains/",body: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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Use all known addresses	Certify for all current addresses when enrolling certificate automatically
array	Addresses override	Explicit list of addresses to certify for when enrolling certificate

Sample uom library read command:

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

⇒

{"210.254.254.26"}

Sample uom library write command:

uom.config.https_cert.addresses={"252.203.250.201"}

Browse more samples

See also Addresses override, if any: Addresses override

Automatic renewal

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample CLI write command:

uom set "config/https_cert/automatic_renewal" "true"

Sample curl write command:

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

Browse more samples

Certificate renewal method

string	config/https_cert/renewal_method/
Method to use when renewing the certificate

The value is subject to the following constraints: renewal methods[the value]

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

Sample curl read command:

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

⇒

"acmev1"

Sample CLI write command:

uom set "config/https_cert/renewal_method" "\"acmev2\""

Browse more samples

See also HTTPS certificate settings: Data

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)

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

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

Changes to this sum cannot be tracked.

This sum can assume the following values:

string	HTTPS certificate signing request	The certificate signing request you need to sign in order to obtain an HTTPS certificate for the unit, to be honored by an external entity
constant false	Certificate signing request generation failure	No valid certificate signing request could be generated, check distinguished name settings

Sample uom library read command:

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

⇒

Sample requests read command:

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

⇒

'-----BEGIN CERTIFICATE REQUEST-----\nMIIJSW5r/HUNFyKn7J6f59qzSHQ/mgi5YSQ1/Yv0rPP7OmwY52DDE3CiNekAKSHv\nzxHuz9KPIkCEIKJYZaeoJ1T3DpXXlUGkRafRl/t4l6K4Sgf2GJsbMLhcBF9zlSjD\nOhqPa==\n-----END CERTIFICATE REQUEST-----\n'

Browse more samples

HTTPS certificate chain

string	config/https_cert/cert/
HTTPS certificate chain presented by the unit to clients (read may fail if renewal is in progress)

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This string represents a value in persistent storage.

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

Changes to this string cannot be tracked.

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

Changes to this string do not take effect immediately.

Sample CLI read command:

uom get "config/https_cert/cert"

⇒

"-----BEGIN CERTIFICATE-----\nMIIfoeWXwB3TUAcMn0vtTHXSE1o+vOuoKAT9q0jnDoGj+v6oy1hSLFwbIlcEAW2W\niZaRMpGfZHah5Ylp175zkQkMgxvlUeJCEvgdlyILFv3NUqDXzKXkmI7SF3ElkZ++\ngeGfzdwviKPZZzZvWKirTA7ZRuJ0uKXb\n-----END CERTIFICATE-----\n"

Sample JS request read command:

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

⇒

Browse more samples

HTTPS certificate key

string	config/https_cert/key/
The key used by the HTTPS certificate presented by the unit; certificate will be renewed as a side effect of writing; writing actual data is not recommended, please use the certificate request signing path instead

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

Retrieving the value is denied

Changing the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

Changes to this string cannot be tracked.

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

Changes to this string do not take effect immediately.

This string should be displayed in a secure manner.

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

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/https_cert/key/',auth=auth,headers=headers,json='-----BEGIN PRIVATE KEY-----\nMII1LcojCQbm4LW182FDcTSGVQMDMGlOo6SAlGvziXlpvIt4M9J+eoHAEgPdyA1n\nz5ov4XSsNOAGUYSqZ7esJvYkYXxcKH8KOzFVXkNw8aDf9iWkrAdA6CxgluJ5CURc\nj80TYze8DJJxs4o2j+BxxujsDq4jIjD1uGXSGBdVXySP3HUpIhmGbV8rMFag/qkv\nHNPU0w2/PT5jzw1gjJIET9dlmKmc4hlO5Av87z9YSGHSDL8ygTDAesxRCj4JRrjY\nfiBeum6B4aQSlO8FdLvWINk2T4WKq4PVpd9jQIxXvN/hoAySXu/rHlwmsS7iZYDO\nP8ek5BgVCNJOMo==\n-----END PRIVATE KEY-----\n')

Sample JS request write command:

request.put({url:"config/https_cert/key/",body:"-----BEGIN PRIVATE KEY-----\nMII/n83wyFlNU4kBARIwDaYGnBAgqiiDTNEHXJEWb/v55gJI7eENEpf10sktaS64\nOPjeyKgtSoan6kSN7iComFgW8H/HNthnJRSHn8BGzn35YXUhGjW2/CaAVbTvVBjq\nB8SMMkLAqTkOzRgj+lkCMwk+QgVePMIcXm+vXM5O==\n-----END PRIVATE KEY-----\n"});

Browse more samples

See also HTTPS certificate settings: Renew certificate

See also HTTPS certificate settings: Generate key

See also HTTPS certificate settings: Known DN OIDs

Renewal methods

map	config/https_cert/known_renewal_methods/
Known renewal methods

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Renewal method elements.

Creating elements in this collection is not supported.

Sample requests read command:

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

⇒

<...>

Sample curl read command:

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

⇒

...

Browse more samples

See also Renewal methods: Renewal method

Distinguished name: Values

array	config/https_cert/distinguished_name/S/
Distinguished name element value set

The value is subject to the following constraints: any of the following is true:

• known DN OIDs[index of the value]
• index of the value matches ^012{1,}

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This array represents a value in persistent storage.

This array contains Value elements.

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

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

⇒

["Digital Loggers Unit"]

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

local composite=uom.copy(uom.config.https_cert.distinguished_name)
uom.insert(composite[_values],1,"Santa Clara")
uom.config.https_cert.distinguished_name=composite

Browse more samples

Value

string	config/https_cert/distinguished_name/S/N/
Distinguished name element value

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This string represents a value in persistent storage.

Sample requests deletion command (note that _values and _value_index are variables):

requests.delete('http://192.168.0.100/restapi/config/https_cert/distinguished_name/'+_values+'/'+str(_value_index)+'/',auth=auth,headers=headers)

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

requests.put('http://192.168.0.100/restapi/config/https_cert/distinguished_name/'+_values+'/'+str(_value_index)+'/',auth=auth,headers=headers,json='Digital Loggers Unit')

Browse more samples

Domain names override, if any: Domain names override

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

This array contains Hostname elements.

Sample curl hostname creation command:

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

Sample requests hostname creation command:

requests.post('http://192.168.0.100/restapi/config/https_cert/domains/',auth=auth,headers=headers,json='baz.example.com')

Browse more samples

Hostname

string	config/https_cert/domains/N/
Hostname to certify for

The value is subject to the following constraints: the value matches ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]).)*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?)$

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

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

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

⇒

"baz.example.com"

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

requests.put('http://192.168.0.100/restapi/config/https_cert/domains/'+str(_hostname_index)+'/',auth=auth,headers=headers,json='bar.example.com')

Browse more samples

Addresses override, if any: Addresses override

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

This array contains IPv4 address elements.

Sample uom library IPv4 address creation command:

uom.insert(uom.config.https_cert.addresses,2,"254.224.8.13")

Sample requests IPv4 address creation command:

requests.post('http://192.168.0.100/restapi/config/https_cert/addresses/',auth=auth,headers=headers,json='254.78.4.227')

Browse more samples

IPv4 address

string	config/https_cert/addresses/N/
IPv4 address to certify for, in dotted quad notation

The value is subject to the following constraints: the value matches ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

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

requests.put('http://192.168.0.100/restapi/config/https_cert/addresses/'+str(_ipv4_address_index)+'/',auth=auth,headers=headers,json='8.252.71.12')

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

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

⇒

"209.5.250.250"

Browse more samples

HTTPS certificate settings: Data

map	config/https_cert/renewal_data/
Renewal-method-specific data

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This map represents a value in persistent storage.

This map contains Data item elements.

Sample requests data item creation command:

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

Sample CLI data item creation command:

uom insert "config/https_cert/renewal_data/days" "\"23\""

Browse more samples

Data item

string	config/https_cert/renewal_data/S/
Item of renewal-method-specific data

The value is subject to the following constraints: the value matches renewal methods[certificate renewal method].data_items[index of the value].regexp

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

• not administrative user
• all of the following is true:
  • index of the value is not equal to ""
  • renewal methods[certificate renewal method].data_items[index of the value].secret

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

• not administrative user
• protect network settings

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

• not administrative user
• all of the following is true:
  • index of the value is not equal to ""
  • renewal methods[certificate renewal method].data_items[index of the value].secret

This string represents a value in persistent storage.

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

• index of the value is not equal to ""
• renewal methods[certificate renewal method].data_items[index of the value].secret

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

uom.config.https_cert.renewal_data[_data_item]="745"

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

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

⇒

""

Browse more samples

HTTPS certificate settings: Renew certificate

call	config/https_cert/renew_cert/
Initiate attempt to renew the certificate using the selected method

Performing the function call is denied if any of the following is true:

• not administrative user
• protect network settings

The call has no arguments (supply empty tuple).

The call returns the following results:

1. Empty result: null

Sample uom library invocation:

uom.config.https_cert.renew_cert()

⇒

(no output)

Sample requests invocation:

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

⇒

(no output)

Browse more samples

Empty result

constant null	config/https_cert/renew_cert/results: 1/
No additional information available

This constant does not correspond to an actual resource.

HTTPS certificate settings: Generate key

call	config/https_cert/generate_key/
Initiate generation of a new private key; certificate renewal will be attempted as a side effect; if that fails, the key is unchanged

Performing the function call is denied if any of the following is true:

• not administrative user
• protect network settings

The call has no arguments (supply empty tuple).

The call returns the following results:

1. Empty result: null

Sample uom library invocation:

uom.config.https_cert.generate_key()

⇒

(no output)

Sample JS request invocation:

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

⇒

(no output)

Browse more samples

Empty result

constant null	config/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

map	config/https_cert/known_dn_oids/
Known distinguished name element object identifiers

Retrieving the value is denied if not administrative user

This map does not support direct modification.

This map contains OID elements.

Creating elements in this collection is not supported.

Sample requests read command:

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

⇒

Sample JS request read command:

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

⇒

Browse more samples

OID

string	config/https_cert/known_dn_oids/S/
Object identifier value

Retrieving the value is denied if not administrative user

This string does not support direct modification.

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

uom get "config/https_cert/known_dn_oids/${oid}"

⇒

"2.5.4.10"

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

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

⇒

"2.5.4.19"

Browse more samples

Supported data items: Data item properties

object	config/https_cert/known_renewal_methods/S/data_items/S/
Properties of data item

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

This object contains the following items:

name	Name
regexp	Regular expression
secret	Secret

Sample uom library read command (note that _renewal_method and _data_item_properties are variables):

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

⇒

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

Sample JS request write command (note that _renewal_method and _data_item_properties are variables):

request.put({url:"config/https_cert/known_renewal_methods/"+_renewal_method+"/data_items/"+_data_item_properties+"/",body:{"regexp":"[ -~]*","name":"Password to use for authentication","secret":true}});

Browse more samples

Name

string	config/https_cert/known_renewal_methods/S/data_items/S/name/
Data item name

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

Sample uom library read command (note that _renewal_method and _data_item_properties are variables):

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

⇒

"ACMEv1 default account key size in bits"

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

⇒

"Password to use for authentication"

Browse more samples

Regular expression

string	config/https_cert/known_renewal_methods/S/data_items/S/regexp/
Regular expression which the data item must match

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

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

⇒

"^[1-9][0-9]*$"

Sample requests read command (note that _renewal_method and _data_item_properties 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())

⇒

'^((]|[!#&\'()*+,/:;=?@[$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

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

This sum can assume the following values:

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

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

request.get({url:"config/https_cert/known_renewal_methods/"+_renewal_method+"/data_items/"+_data_item_properties+"/secret/"},function(error,response,body) {console.log(body)});

⇒

false

Sample 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

object	config/https_cert/known_renewal_methods/S/
Method of certificate renewal

Retrieving the value is denied if not administrative user

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

This object contains the following items:

name	Name
data_items	Supported data items

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

uom set "config/https_cert/known_renewal_methods/${renewal_method}" "{\"name\":\"Obtain a certificate from an ACME v2 endpoint (e.g. Let's Encrypt)\",\"data_items\":{\"acmev2_auth_algorithm\":{\"regexp\":\"^(RS256|RS384|RS512|ES256|ES384|ES512)$\",\"name\":\"ACMEv2 authentication algorithm\",\"secret\":false},\"acmev2_contacts\":{\"regexp\":\"^((]|[!#&'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))| )+$\",\"name\":\"ACMEv2 contact URLs, whitespace-separated\",\"secret\":false},\"acmev2_agreement\":{\"regexp\":\"^((]|[!#&'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))| )+$\",\"name\":\"ACMEv2 service agreement\",\"secret\":false},\"acmev2_url\":{\"regexp\":\"^https?://(]|[!#&'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))+$\",\"name\":\"ACMEv2 directory endpoint URL\",\"secret\":false}}}"

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

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

⇒

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

Browse more samples

Name

string	config/https_cert/known_renewal_methods/S/name/
Renewal method name

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

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

⇒

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

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

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

⇒

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

Browse more samples

Supported data items

map	config/https_cert/known_renewal_methods/S/data_items/
Properties of supported data items

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Data item properties elements.

Creating elements in this collection is not supported.

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

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

⇒

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

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

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

⇒

Browse more samples

See also Supported data items: Data item properties

Certificate collection

map	config/certificates/
Map of known certificates and their settings

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This map represents a value in persistent storage.

Changes to this map do not take effect immediately.

This map contains Certificate elements.

Sample requests read command:

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

⇒

<...>

Sample CLI read command:

uom get "config/certificates"

⇒

...

Browse more samples

See also Certificate collection: Certificate

Certificate collection: Certificate

object	config/certificates/S/
Certificate settings

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This object represents a value in persistent storage.

Changes to this object do not take effect immediately.

This object contains the following items:

data	Data
status	Trust status

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

uom set "config/certificates/${certificate}" "{\"data\":\"-----BEGIN CERTIFICATE-----\\nMIIrai5cRJMgMFbBPaY8tUSw+tCwKCduE2lqnsTECrwb7YoZ9Nj2uB/u5ErRTVLj\\naM04cFyZs58hgJ5QN/ePwlfoC8JauvkVHnbw2ZVxhfeN/mqPnUqkFWYUgu4bpr67\\nk3iKbf2HKRI6Hjwoag36FZp9gR/Ya8CKDxhrcl8zDT5XD2LpkQy/0nBjFDHrNWCd\\nvU6he5w8DUNHrC1IB3L/H5GWO7vxLY=\\n-----END CERTIFICATE-----\\n\",\"status\":true}"

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

uom.config.certificates[_certificate]={data="-----BEGIN CERTIFICATE-----\
MIILXjY49eAT6PmeSR+4VyXISdvN1B6U9Nsj7QqJ40oDSbtx2u1atbvMFqlI1tpD\
yR8pmFraUKBOHGJLsCyoaDeMYhGOxa5w1GlpXdQ2zdSGwnep0cddsI/R0Hrztzvx\
hmpKCtKsMdpAHeCvIroctGeB7d47Z2PGqFd38zxXcmjvRxrlpfNix2v5h0FH4hZx\
C07B+gqnPlENc0CIQxFUsNCveV/L4yKJ/TX/ANob93/n5E5YBN24mG/Rn1pu/9D0\
n2rAtTLyU94lHeygj3T/4xp7mj9yzCdmGUz9zL8UWEFqvDWeI0gPzVZmEkkEzN0G\
0RtNcNwtempuJTCLAeLhD7y+uD+HFGAIk3hMTeF7R41maG8mwWUAfT\
-----END CERTIFICATE-----\
",status=false}

Browse more samples

Data

string	config/certificates/S/data/
Certificate data

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

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

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

⇒

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

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

⇒

Browse more samples

Trust status

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant true	Trusted	The certificate is trusted by all software with default settings
constant false	Untrusted	The certificate is not trusted by all software with default settings

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

requests.put('http://192.168.0.100/restapi/config/certificates/'+_certificate+'/status/',auth=auth,headers=headers,json=True)

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

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

Browse more samples

Certificate revocation list collection

map	config/crls/
Map of known certificate revocation lists and their settings

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This map represents a value in persistent storage.

Changes to this map do not take effect immediately.

This map contains Certificate revocation list elements.

Sample CLI write command:

uom set "config/crls" "{\"eCyberBarSign_Primary_CA_8\":{\"data\":\"-----BEGIN X509 CRL-----\\nMII0Li2x4fzhUb27y6606CjZxE+UvnW6Ln9jVDgcvgJPIOYGWgJfv2FtJGNE3vNQ\\nAEostjZC8tdjA9QVrLa6EvOeAUZZxJ87Zy0ShbhsUKbgW1COOoWfkxJwRvWPEhYq\\naJOB1GiOtPxxdLMSu1CrM8JIhkZOJP4vkU7omsCgH9=\\n-----END X509 CRL-----\\n\",\"status\":false}}"

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/crls/',auth=auth,headers=headers,json={'eSecureBazCare_Primary_CA': {'data': '-----BEGIN X509 CRL-----\nMIIoW0AOeF63d7nggL6bUxES3wM2bNTd5YSeaf2EwAKaK7G0VPe/MvTSrsXTG07O\n2BH7SEKpqgz7jUYNWxI0PAuyfB/pbcRgqkpJ+98rs7/beZ/AXJCzW7xCLz1ybUfS\nVnFhy6Z68BmjCzHYCG4MEIjDLirsNK7v7Oc6XCEhP1Rd1kCF1IdHdMX/5PtUl0Pv\n21+GIihL9LPwZh+uKIXjrYqGSL1U==\n-----END X509 CRL-----\n', 'status': False}})

Browse more samples

See also Certificate revocation list collection: Certificate revocation list

Certificate revocation list collection: Certificate revocation list

object	config/crls/S/
Certificate revocation list settings

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This object represents a value in persistent storage.

Changes to this object do not take effect immediately.

This object contains the following items:

data	Data
status	Usage status

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

uom set "config/crls/${certificate_revocation_list}" "{\"data\":\"-----BEGIN X509 CRL-----\\nMIItwPta4AYoO6cJdLrQL2utsVlZ3/VVXSPTuI3/VdpvmRFPp7sABn34IrgOtBvQ\\nvbf/dBeS7RwOtmYlylZ2rtwXHplDGSaB3GDjUtCdL82Exc0vOb+FVxppma323fG9\\nVuSP66nHA1Ep4ADiBVD8K3xx8/0qICoq6GFFO2Yb6pRC0gwDCANYFKWQMZGhn5Xw\\noBotmQ/ctEeaBuoOHNgev61VP==\\n-----END X509 CRL-----\\n\",\"status\":true}"

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

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

⇒

Browse more samples

Data

string	config/crls/S/data/
CRL data

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

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

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

⇒

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

uom.config.crls[_certificate_revocation_list].data="-----BEGIN X509 CRL-----\
MIIaPpnxm6YUBc4bsmHogJIOgIEJ9UHXPq8qfyoS4MzH/3vtrChYY0yEKDZWkt39\
0PBrtIEtcFyX8qmrOKtNaEcAmN3sYp6bFKS9ei2G+1q8tc0IyviZAKmzjsrIi+wz\
P8/7CI7G8I9mKUlGCLSZ7R=\
-----END X509 CRL-----\
"

Browse more samples

Usage status

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant true	Used	The certificate revocation list is used by all software with default settings
constant false	Unused	The certificate revocation list is not used by all software with default settings

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

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

⇒

true

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

requests.put('http://192.168.0.100/restapi/config/crls/'+_certificate_revocation_list+'/status/',auth=auth,headers=headers,json=False)

Browse more samples

SSH enabled

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample requests write command:

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

Sample JS request write command:

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

Browse more samples

SSH port number

number	config/ssh_port/
Port number of the SSH server

The value is subject to the following constraints: all of the following is true:

• the value is an integer
• the value is greater than 0
• the value is less than 65535

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This number represents a value in persistent storage.

Changes to this number do not take effect immediately.

Sample requests write command:

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

Sample CLI write command:

uom set "config/ssh_port" "22"

Browse more samples

SSH authorized keys

array	config/ssh_authorized_keys/
List of public keys allowed to log in

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This array represents a value in persistent storage.

Changes to this array do not take effect immediately.

This array contains SSH authorized key elements.

Sample curl write command:

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[{\"data\":\"ecdsa-sha2-nistp256  8Z==\",\"options\":\"gcpr=ks,mrntd=7747557,h=074,wzq=wtwagvd\",\"comment\":\"ot\"},{\"data\":\"ecdsa-sha2-nistp256 7tST=\",\"options\":\"\",\"comment\":\"hjifd\"},{\"data\":\"ecdsa-sha2-nistp256      t==\",\"options\":\"xb,ffntcrmwjck=48\",\"comment\":\"rf\"},{\"data\":\"ssh-ed25519           fs\",\"options\":\"xikv,xa,sply,w=a,fzc=963,ay=850,wgg,njhy=1140881380,or=s\",\"comment\":\"zemfux\"}]" "http://192.168.0.100/restapi/config/ssh_authorized_keys/"

Sample requests SSH authorized key creation command:

requests.post('http://192.168.0.100/restapi/config/ssh_authorized_keys/',auth=auth,headers=headers,json={'data': 'ecdsa-sha2-nistp256  9===', 'options': '', 'comment': ''})

Browse more samples

See also SSH authorized keys: SSH authorized key

SSH authorized keys: SSH authorized key

object	config/ssh_authorized_keys/N/
Public key allowed to log in

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This object represents a value in persistent storage.

Changes to this object do not take effect immediately.

This object contains the following items:

data	Data
options	Options
comment	Comment

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

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

⇒

{"data":"ssh-dss  0dS","options":"","comment":""}

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

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

⇒

{'data': 'ecdsa-sha2-nistp521 y0', 'options': 'cjvk,fmfoi', 'comment': ''}

Browse more samples

Data

string	config/ssh_authorized_keys/N/data/
Public key data

The value is subject to the following constraints: the value matches ^(([0-9])+ *([0-9])+ *([0-9])+|(ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-ed25519|ssh-dss|ssh-rsa) *([0-9A-Za-z+/]+[=]{0,3}))$

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

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

request.put({url:"config/ssh_authorized_keys/"+_ssh_authorized_key_index.toString()+"/data/",body:"ssh-rsa    qtC7==="});

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

uom set "config/ssh_authorized_keys/${ssh_authorized_key_index}/data" "\"ssh-rsa  Z=\""

Browse more samples

Options

string	config/ssh_authorized_keys/N/options/
Public key options

The value is subject to the following constraints: the value matches ^([^ "]+|"[^"]*")*$

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

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

print(requests.get('http://192.168.0.100/restapi/config/ssh_authorized_keys/'+str(_ssh_authorized_key_index)+'/options/',auth=auth,headers=headers).json())

⇒

'qymarpi=7,m=gaqq'

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

uom.config.ssh_authorized_keys[_ssh_authorized_key_index].options="b=10301,ypi=xw,tlvuc=a"

Browse more samples

Comment

string	config/ssh_authorized_keys/N/comment/
Public key comment

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

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

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

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

request.get({url:"config/ssh_authorized_keys/"+_ssh_authorized_key_index.toString()+"/comment/"},function(error,response,body) {console.log(body)});

⇒

""

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

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

⇒

""

Browse more samples

NTP server enabled

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample uom library read command:

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

⇒

true

Sample uom library write command:

uom.config.ntp_server_enabled=false

Browse more samples

NTP peers

array	config/ntp_peers/
List of NTP servers to get time information from

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This array represents a value in persistent storage.

Changes to this array do not take effect immediately.

This array contains NTP peer elements.

Sample CLI write command:

uom set "config/ntp_peers" "[\"0.ntp-pool.example.com\",\"1.ntp-pool.example.com\",\"2.ntp-pool.example.com\",\"3.ntp-pool.example.com\"]"

Sample curl write command:

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[\"0.ntp-pool.example.com\",\"1.ntp-pool.example.com\",\"2.ntp-pool.example.com\",\"3.ntp-pool.example.com\"]" "http://192.168.0.100/restapi/config/ntp_peers/"

Browse more samples

NTP peer

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

string	Hostname	Hostname	the value matches ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]).)*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?)$
string	IPv4 address	IPv4 address in dotted quad notation	the value matches ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

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

uom.remove(uom.config.ntp_peers,_ntp_peer_index)

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

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

⇒

"1.ntp-pool.example.com"

Browse more samples

Syslog threshold severity

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant 1	Emergency	Log when unit becomes unstable or unusable
constant 2	Alert	Log conditions requiring immediate action
constant 3	Critical	Log critical conditions
constant 4	Error	Log error conditions
constant 5	Warning	Log warning conditions
constant 6	Notice	Log normal but significant conditions
constant 7	Informational	Log informational messages
constant 8	Debug	Log tracing and debugging messages

Sample JS request write command:

request.put({url:"config/syslog_minimal_severity/",body:8});

Sample CLI write command:

uom set "config/syslog_minimal_severity" "8"

Browse more samples

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant null	Syslog server disabled	System log messages are not forwarded to a server
string	Hostname	Hostname	the value matches ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]).)*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?)$
string	IPv4 address	IPv4 address in dotted quad notation	the value matches ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

Sample curl write command:

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "null" "http://192.168.0.100/restapi/config/syslog_ip_address/"

Sample curl read command:

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

⇒

null

Browse more samples

Allow JSON-RPC

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample JS request write command:

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

Sample uom library read command:

print(uom.dump(uom.config.allow_jsonrpc))

⇒

false

Browse more samples

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample uom library read command:

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

⇒

false

Sample JS request write command:

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

Browse more samples

Allow REST-like API

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample uom library write command:

uom.config.allow_restapi=false

Sample curl write command:

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

Browse more samples

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample CLI write command:

uom set "config/allow_restapi_nonadmin" "true"

Sample requests write command:

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

Browse more samples

Allowed REST-like API client origins

array	config/allow_restapi_origins/
List of origins permitted to access the REST-like API

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This array represents a value in persistent storage.

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

Sample curl write command:

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[\"https://foo.example.com:8443\",\"https://bar.example.com:8443\"]" "http://192.168.0.100/restapi/config/allow_restapi_origins/"

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

uom.insert(uom.config.allow_restapi_origins,1,"http://bar.example.com")

Browse more samples

Allowed REST-like API client origin

string	config/allow_restapi_origins/N/
Origin permitted to access the REST-like API

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

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

uom remove "config/allow_restapi_origins/${allowed_rest_like_api_client_origin_index}"

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

uom.config.allow_restapi_origins[_allowed_rest_like_api_client_origin_index]="https://bar.example.com:8443"

Browse more samples

Allow CoAP over WebSockets

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample requests read command:

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

⇒

False

Sample CLI write command:

uom set "config/allow_coapws" "true"

Browse more samples

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample uom library read command:

print(uom.dump(uom.config.allow_coapws_nonadmin))

⇒

false

Sample CLI read command:

uom get "config/allow_coapws_nonadmin"

⇒

false

Browse more samples

Allowed CoAP over WebSockets client origins

array	config/allow_coapws_origins/
List of origins permitted to access CoAP over WebSockets

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This array represents a value in persistent storage.

This array contains Allowed CoAP over WebSockets client origin elements.

Sample curl allowed CoAP over WebSockets client origin creation command:

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

Sample requests write command:

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

Browse more samples

Allowed CoAP over WebSockets client origin

string	config/allow_coapws_origins/N/
Origin permitted to access CoAP over WebSockets

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

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

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

⇒

'https://baz.example.com'

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

requests.put('http://192.168.0.100/restapi/config/allow_coapws_origins/'+str(_allowed_coap_over_websockets_client_origin_index)+'/',auth=auth,headers=headers,json='http://baz.example.com')

Browse more samples

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)

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample requests write command:

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

Sample CLI write command:

uom set "config/relax_nonhtml_methods" "true"

Browse more samples

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)

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample requests read command:

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

⇒

False

Sample requests write command:

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

Browse more samples

Allow plaintext logins

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample CLI read command:

uom get "config/allow_plaintext_logins"

⇒

true

Sample requests read command:

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

⇒

True

Browse more samples

Allow state-changing GET requests

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample CLI write command:

uom set "config/allow_modifying_get" "true"

Sample curl write command:

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

Browse more samples

Relay name visibility

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

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Everywhere	Relay name visible everywhere, including the login page
constant false	Authorized users only	Relay name visible only on pages which require authorization

Sample CLI write command:

uom set "config/name_always_visible" "false"

Sample curl write command:

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

Browse more samples

Hide user passwords

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Hide	Do not display user passwords in web UI
constant false	Show	Display user passwords in web UI

Sample uom library write command:

uom.config.hide_passwords=true

Sample JS request read command:

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

⇒

false

Browse more samples

Hide WiFi key

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Hide	Do not display WiFi key in web UI
constant false	Show	Display WiFi key in web UI

Sample uom library write command:

uom.config.hide_wifi_key=false

Sample curl read command:

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

⇒

true

Browse more samples

Security lockout duration

number	config/lockout_delay_minutes/
Time during which, after several unsuccessful logins, subsequent logins are denied

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

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample requests write command:

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

Sample uom library write command:

uom.config.lockout_delay_minutes=60

Browse more samples

Protect firmware

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• the value

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Protected	Associated object cannot be changed
constant false	Not protected	Associated object can be changed

Sample requests write command:

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

Sample CLI read command:

uom get "config/protect_firmware"

⇒

false

Browse more samples

Protect admin login

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• the value

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Protected	Associated object cannot be changed
constant false	Not protected	Associated object can be changed

Sample JS request read command:

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

⇒

false

Sample requests write command:

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

Browse more samples

Protect network settings

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• the value

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Protected	Associated object cannot be changed
constant false	Not protected	Associated object can be changed

Sample CLI read command:

uom get "config/protect_network"

⇒

true

Sample curl write command:

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

Browse more samples

Protect private settings

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• the value

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Protected	Associated object cannot be changed
constant false	Not protected	Associated object can be changed

Sample curl write command:

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

Sample JS request write command:

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

Browse more samples

Protect from restore

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

Retrieving the value is denied if not administrative user

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

• not administrative user
• the value

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Protected	Associated object cannot be changed
constant false	Not protected	Associated object can be changed

Sample curl read command:

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

⇒

true

Sample JS request read command:

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

⇒

false

Browse more samples

Protect from maintenance

sum (boolean)	config/protect_maintenance/
Disable remote maintenance support

Retrieving the value is denied if not administrative user

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

• not administrative user
• the value

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Protected	Associated object cannot be changed
constant false	Not protected	Associated object can be changed

Sample JS request read command:

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

⇒

true

Sample requests write command:

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

Browse more samples

Protect notification settings

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

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

• not administrative user
• agent identifier is not equal to notification

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

• not administrative user
• the value

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Protected	Associated object cannot be changed, and its security-related parameters cannot be read
constant false	Not protected	Associated object can be changed, and its security-related parameters can be read
constant "sender"	Protect sender configuration	Associated object cannot be changed, and its security-related parameters cannot be read; properties not related to sender configuration can still be read and changed

Sample JS request read command:

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

⇒

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample curl read command:

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

⇒

false

Sample uom library write command:

uom.config.upgrade_notify_beep=true

Browse more samples

Blink on upgrade

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample uom library read command:

print(uom.dump(uom.config.upgrade_notify_blink))

⇒

true

Sample JS request read command:

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

⇒

true

Browse more samples

Known quantities

map	config/known_quantities/
Map of known physical quantities

This map does not support direct modification.

This map represents a value in persistent storage.

This map contains Quantity elements.

Creating elements in this collection is not supported.

Sample requests read command:

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

⇒

<...>

Sample CLI read command:

uom get "config/known_quantities"

⇒

...

Browse more samples

Quantity

object	config/known_quantities/S/
Physical quantity

This object contains the following items:

name	Name
units	Known units
preferred_unit	Preferred unit, if any

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

request.put({url:"config/known_quantities/"+_quantity+"/",body:{"preferred_unit":"A","name":"Current","units":{"A":{"offset":0,"internal":false,"name":"ampere","scale":1}}}});

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

uom get "config/known_quantities/${quantity}"

⇒

{"preferred_unit":"times","name":"Count","units":{"times":{"offset":0,"internal":true,"name":"time","scale":1}}}

Browse more samples

See also Quantity: Name

See also Quantity: Known units

See also Quantity: Preferred unit, if any

Quantity: Name

string	config/known_quantities/S/name/
Quantity name

This string does not support direct modification.

This string represents a value in persistent storage.

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

uom get "config/known_quantities/${quantity}/name"

⇒

"Energy"

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

print(uom.dump(uom.config.known_quantities[_quantity].name))

⇒

"Current"

Browse more samples

Quantity: Known units

map	config/known_quantities/S/units/
Map of known units for quantity

Changing the value is denied if not administrative user

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

This map represents a value in persistent storage.

This map contains Unit elements.

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

print(uom.dump(uom.config.known_quantities[_quantity].units))

⇒

{J={internal=true,name="joule",offset=0,scale=1},kWh={internal=true,name="kilowatt-hour",offset=0,scale=2.77777778e-07}}

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

uom.config.known_quantities[_quantity].units={C={name="degree Celsius",offset=-273.16,scale=1},F={name="degree Fahrenheit",offset=-459.67,scale=1.8},K={name="kelvin",offset=0,scale=1}}

Browse more samples

Unit

object	config/known_quantities/S/units/S/
Unit of physical quantity

Changing the value is denied if not administrative user

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

This object does not support direct modification if internal.

This object represents a value in persistent storage.

This object contains the following items:

name	Name
scale	Scaling factor
offset	Offset
internal	Internal

Sample requests write command (note that _quantity and _unit are variables):

requests.put('http://192.168.0.100/restapi/config/known_quantities/'+_quantity+'/units/'+_unit+'/',auth=auth,headers=headers,json={'offset': 0, 'internal': False, 'name': 'volt', 'scale': 1})

Sample CLI read command (note that quantity and unit are variables):

uom get "config/known_quantities/${quantity}/units/${unit}"

⇒

{"offset":0,"internal":true,"name":"","scale":1}

Browse more samples

Name

string	config/known_quantities/S/units/S/name/
Unit name

Changing the value is denied if not administrative user

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

This string does not support direct modification if internal.

This string represents a value in persistent storage.

Sample CLI read command (note that quantity and unit are variables):

uom get "config/known_quantities/${quantity}/units/${unit}/name"

⇒

"kilowatt-hour"

Sample curl write command (note that :quantity and :unit are URL template arguments):

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"volt\"" "http://192.168.0.100/restapi/config/known_quantities/:quantity/units/:unit/name/"

Browse more samples

Scaling factor

number	config/known_quantities/S/units/S/scale/
Scaling factor for conversion from standard SI unit

Changing the value is denied if not administrative user

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

This number does not support direct modification if internal.

This number represents a value in persistent storage.

Sample curl write command (note that :quantity and :unit are URL template arguments):

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "1" "http://192.168.0.100/restapi/config/known_quantities/:quantity/units/:unit/scale/"

Sample requests read command (note that _quantity and _unit are variables):

print(requests.get('http://192.168.0.100/restapi/config/known_quantities/'+_quantity+'/units/'+_unit+'/scale/',auth=auth,headers=headers).json())

⇒

1

Browse more samples

Offset

number	config/known_quantities/S/units/S/offset/
Offset for conversion from standard SI unit

Changing the value is denied if not administrative user

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

This number does not support direct modification if internal.

This number represents a value in persistent storage.

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

⇒

0

Sample uom library write command (note that _quantity and _unit are variables):

uom.config.known_quantities[_quantity].units[_unit].offset=0

Browse more samples

Internal

sum (boolean)	config/known_quantities/S/units/S/internal/
Flag indicating whether this measurement unit is internal

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

This sum does not support direct modification.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Internal	This unit is internal and cannot be modified
constant false	User	This unit is user-supplied and can be modified

Sample curl read command (note that :quantity and :unit are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/known_quantities/:quantity/units/:unit/internal/"

⇒

true

Sample requests read command (note that _quantity and _unit are variables):

print(requests.get('http://192.168.0.100/restapi/config/known_quantities/'+_quantity+'/units/'+_unit+'/internal/',auth=auth,headers=headers).json())

⇒

True

Browse more samples

Quantity: Preferred unit, if any

sum (optional string)	config/known_quantities/S/preferred_unit/
Default UI unit for quantity, if any

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Standard unit	UI shows quantity in SI units
string	Preferred unit	Default UI unit for quantity	known units[the value]

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

uom set "config/known_quantities/${quantity}/preferred_unit" "\"C\""

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

request.put({url:"config/known_quantities/"+_quantity+"/preferred_unit/",body:null});

Browse more samples

Known timezones

map	config/known_timezones/
Map of known time zones

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map represents a value in persistent storage.

This map contains Timezone elements.

Creating elements in this collection is not supported.

Sample curl read command:

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

⇒

Sample JS request read command:

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

⇒

Browse more samples

Timezone

string	config/known_timezones/S/
Time zone name

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

This string represents a value in persistent storage.

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

print(uom.dump(uom.config.known_timezones[_timezone]))

⇒

"UTC-6"

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

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

⇒

"UTC+7"

Browse more samples

Known protection bits

map	config/known_protection_bits/
Map of known protection bits

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Protection bit elements.

Creating elements in this collection is not supported.

Sample curl read command:

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

⇒

Sample uom library read command:

print(uom.dump(uom.config.known_protection_bits))

⇒

Browse more samples

See also Known protection bits: Protection bit

Known protection bits: Protection bit

object	config/known_protection_bits/S/
Protection bit properties

Retrieving the value is denied if not administrative user

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

This object contains the following items:

name	Name
status	Protection status

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

requests.put('http://192.168.0.100/restapi/config/known_protection_bits/'+_protection_bit+'/',auth=auth,headers=headers,json={'name': 'Maintenance mode lock', 'status': False})

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

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

⇒

{'name': 'Administrator credentials protection', 'status': True}

Browse more samples

Name

string	config/known_protection_bits/S/name/
Protection bit name

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

This string does not support direct modification.

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

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

⇒

'Private configuration protection'

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

print(uom.dump(uom.config.known_protection_bits[_protection_bit].name))

⇒

"Maintenance mode lock"

Browse more samples

Protection status

sum (variant)	config/known_protection_bits/S/status/
Status of protection

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

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

Changes to this sum cannot be tracked.

This sum can assume the following values:

constant true	Enabled	Protection is enabled and effective
constant false	Disabled	Protection is disabled
string	Ineffective	Protection is enabled, but not effective for the following reason

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

print(uom.dump(uom.config.known_protection_bits[_protection_bit].status))

⇒

false

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

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

⇒

false

Browse more samples

Relay ports

array	config/relay_ports/
List of devices to which relay modules are connected

Retrieving the value is denied if not administrative user

This array does not support direct modification.

This array represents a value in persistent storage.

This array is expected to be visible to advanced users only.

This array contains Relay port elements.

Creating elements in this collection is not supported.

Sample requests read command:

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

⇒

['ttyATH0']

Sample uom library read command:

print(uom.dump(uom.config.relay_ports))

⇒

{"ttyATH0"}

Browse more samples

Relay port

string	config/relay_ports/N/
Filename of a relay module device

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

This string is expected to be visible to advanced users only.

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

print(uom.dump(uom.config.relay_ports[_relay_port_index]))

⇒

"ttyATH0"

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

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

⇒

"ttyATH0"

Browse more samples