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
bootloader_id	Bootloader ID
art_id	ART ID
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_tls_ciphers	Custom HTTPS TLS cipher list, if any
expand_tls_ciphers	Expand a TLS cipher list
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
ssh_password_auth_enabled	Enable SSH password authentication
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_plaintext_url_logins	Allow plaintext URL logins
allow_modifying_get	Allow state-changing GET requests
allow_http_hostnames	Allowed HTTP hostnames
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
known_component_versions	Known component versions
relay_ports	Relay ports

Sample curl write command:

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

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

uom.config.links={{description="test 5",href="test_url7"},{description="test 3",href="test_url5"}}

Sample uom library link creation command:

uom.insert(uom.config.links,1,{description="test 5",href="test_url7"})

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

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

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

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

⇒

{"description":"test 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 read command (note that link_index is a variable):

uom get "config/links/${link_index}/href"

⇒

"test_url5"

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

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

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

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

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

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"test 5\"" "http://192.168.0.100/restapi/config/links/:link_index/description/"

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

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

Sample curl plot creation command:

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"x2\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"data\":[{\"ds\":\"power_voltage\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"FF0000\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size\":0},\"title\":\"Power voltage\"}],\"width\":640,\"title\":\"Power voltage\",\"y2\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"height\":480,\"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},\"display\":true}" "http://192.168.0.100/restapi/config/plots/"

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
duration	Duration
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 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"x2\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"duration\":86400,\"data\":[{\"ds\":\"buses.0.total_energy\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"FF0000\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size\":0},\"title\":\"Bus A total energy\"},{\"ds\":\"buses.1.total_energy\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"0000FF\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size\":0},\"title\":\"Bus B total energy\"}],\"width\":640,\"title\":\"Bus energy consumption\",\"y2\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"height\":480,\"y1\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"x1\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"display\":true}" "http://192.168.0.100/restapi/config/plots/:plot_index/"

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

uom set "config/plots/${plot_index}" "{\"x2\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"data\":[{\"ds\":\"buses.0.total_energy\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"FF0000\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size\":0},\"title\":\"Bus A total energy\"},{\"ds\":\"buses.1.total_energy\",\"style\":{\"type\":\"solid\",\"style\":\"lines\",\"width\":1,\"color\":\"0000FF\",\"axes\":\"x1y1\",\"marker\":\"plus\",\"size\":0},\"title\":\"Bus B total energy\"}],\"width\":640,\"title\":\"Bus energy consumption\",\"y2\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"height\":480,\"y1\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"x1\":{\"min\":null,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null},\"display\":false}"

Browse more samples

See also Plot: Title

See also Plot: Display

See also Plot: Width

See also Plot: Height

See also Plot: Duration

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

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

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

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

⇒

"Illuminance"

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

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

⇒

False

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

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

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

uom.config.plots[_plot_index].width=640

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

⇒

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

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

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

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

Browse more samples

Plot: Duration

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

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

The value is unconditionally set to 86400 on creation and doesn't have to be supplied (if it is, it must match)

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

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

uom set "config/plots/${plot_index}/duration" "86400"

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

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

⇒

86400

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 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,"softmax":null,"max":null,"tics":null,"mtics":null,"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)+'/x1/',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/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 curl write command (note that :plot_index is a URL template argument):

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

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

uom get "config/plots/${plot_index}/x1/max"

⇒

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

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

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

uom get "config/plots/${plot_index}/x1/softmin"

⇒

null

Browse more samples

Soft maximum, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

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

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

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

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 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/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)+'/x1/tics/',auth=auth,headers=headers,json=None)

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

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

⇒

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

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

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

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

⇒

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

Browse more samples

Minimum, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

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

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

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

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

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

⇒

null

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

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

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

uom get "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 CLI read command (note that plot_index is a variable):

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

⇒

null

Browse more samples

Major tick interval, if any

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

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

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

⇒

null

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

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

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

uom.config.plots[_plot_index].x2.mtics=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 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': 0, 'softmax': None, 'max': None, 'tics': None, 'mtics': None, 'softmin': None})

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

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"min\":0,\"softmax\":null,\"max\":null,\"tics\":null,\"mtics\":null,\"softmin\":null}" "http://192.168.0.100/restapi/config/plots/:plot_index/y1/"

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

uom set "config/plots/${plot_index}/y1/min" "0"

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

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

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

⇒

null

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

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

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

uom.config.plots[_plot_index].y1.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/softmin/',auth=auth,headers=headers,json=None)

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

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

⇒

1

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

Browse more samples

Major tick interval, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

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

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

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

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

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

Browse more samples

Minor ticks per major tick, if any

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

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)+'/y1/mtics/',auth=auth,headers=headers,json=None)

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

⇒

None

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

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

⇒

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

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

uom get "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 CLI write command (note that plot_index is a variable):

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

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

uom.config.plots[_plot_index].y2.max=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/max/',auth=auth,headers=headers,json=None)

Browse more samples

Soft minimum, if any

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

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

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

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

⇒

null

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

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

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

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

⇒

null

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

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

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

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

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

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

⇒

null

Browse more samples

Minor ticks per major tick, if any

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

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

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

⇒

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

⇒

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

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

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

⇒

{'type': 'solid', 'style': 'lines', 'width': 1, 'color': '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 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.style))

⇒

"lines"

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

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

⇒

"lines"

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 requests read command (note that _plot_index and _plot_line_configuration_index are variables):

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

⇒

'solid'

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

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

⇒

"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 requests write command (note that _plot_index and _plot_line_configuration_index are variables):

requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/data/'+str(_plot_line_configuration_index)+'/style/color/',auth=auth,headers=headers,json='FF0000')

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/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 uom library write command (note that _plot_index and _plot_line_configuration_index are variables):

uom.config.plots[_plot_index].data[_plot_line_configuration_index].style.width=1

Sample 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 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"plus\"" "http://192.168.0.100/restapi/config/plots/:plot_index/data/:plot_line_configuration_index/style/marker/"

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

⇒

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

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

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "0" "http://192.168.0.100/restapi/config/plots/:plot_index/data/:plot_line_configuration_index/style/size/"

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

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

⇒

"x1y1"

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.axes="x1y1"

Browse more samples

Plot: Plot lines

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

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 Plot line configuration elements.

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

requests.post('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/data/',auth=auth,headers=headers,json={'ds': 'buses.0.total_energy', 'style': {'type': 'solid', 'style': 'lines', 'width': 1, 'color': 'FF0000', 'axes': 'x1y1', 'marker': 'plus', 'size': 0}, 'title': 'Bus A total energy'})

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

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

⇒

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

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

requests.put('http://192.168.0.100/restapi/config/plots/'+str(_plot_index)+'/data/'+str(_plot_line_configuration_index)+'/',auth=auth,headers=headers,json={'ds': 'buses.1.current', 'style': {'type': 'solid', 'style': 'lines', 'width': 1, 'color': '0000FF', 'axes': 'x1y2', 'marker': 'plus', 'size': 0}, 'title': 'Bus B current'})

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 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].ds="buses.1.current"

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"

⇒

"environment.temperature"

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

⇒

"Illuminance"

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

uom set "config/plots/${plot_index}/data/${plot_line_configuration_index}/title" "\"Bus A voltage\""

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

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

⇒

<...>

Sample requests meter configuration creation command:

requests.post('http://192.168.0.100/restapi/config/meters/',auth=auth,headers=headers,json={'decimals': 1, 'color': '', 'sectors': [{'color': '00FF00', 'name': 'Optimal', 'value': 12}, {'color': 'FF0000', 'name': 'High', 'value': 15}], 'data': 'buses.0.current', 'width': 128, 'title': 'Bus A current', 'display': True, 'min_value': 0, 'scale': 'linear', 'height': 64})

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

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

⇒

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

request.delete({url:"config/meters/"+_meter_configuration_index.toString()+"/"});

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

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

⇒

"Bus B current"

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

⇒

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

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

⇒

false

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

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

⇒

"power_voltage"

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

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

⇒

"buses.0.current"

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

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

⇒

128

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

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

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

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)

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

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

⇒

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

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

⇒

0

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

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

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

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

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

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

⇒

""

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

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

⇒

4

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

uom.config.meters[_meter_configuration_index].min_value=4

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 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)+'/sectors/',auth=auth,headers=headers,json=[{'color': '0000FF', 'name': 'Low', 'value': 100}, {'color': '00FF00', 'name': 'Optimal', 'value': 127}, {'color': 'FF0000', 'name': 'High', 'value': 140}])

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

request.post({url:"config/meters/"+_meter_configuration_index.toString()+"/sectors/",body:{"color":"0000FF","name":"Low","value":4.3}});

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

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

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

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

⇒

{color="FF0000",name="High",value=15}

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 curl read command (note that :meter_configuration_index and :sector_configuration_index are URL template arguments):

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

⇒

"High"

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}/name" "\"High\""

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

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

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

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

⇒

15

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 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"00FF00\"" "http://192.168.0.100/restapi/config/meters/:meter_configuration_index/sectors/:sector_configuration_index/color/"

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

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

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

uom set "config/contact" "\"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 JS request write command:

request.put({url:"config/contacts/",body:{"engineering":{"phone":"+1874213630957","fax":null,"name":"Engineering","email":"engineering@bar.example.com"},"security":{"phone":null,"fax":"+19746833813492","name":"Security","email":"security@baz.example.com"}}});

Sample CLI write command:

uom set "config/contacts" "{\"engineering\":{\"phone\":\"+8909557095510\",\"fax\":\"+70105923086882\",\"name\":\"Engineering\",\"email\":\"engineering@bar.example.com\"},\"sales\":{\"phone\":null,\"fax\":null,\"name\":\"Sales\",\"email\":null},\"security\":{\"phone\":null,\"fax\":null,\"name\":\"Security\",\"email\":\"security@foo.example.com\"}}"

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

uom.remove(uom.config.contacts,_contact)

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

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

⇒

{email=null,fax="+8182628515697",name="Security",phone="+186729879814633"}

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

⇒

"Support"

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

uom.config.contacts[_contact].name="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 requests write command (note that _contact is a variable):

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

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

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

⇒

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

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

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

⇒

"+3532179308615"

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

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

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

Sample uom library write command:

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

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

uom get "config/version"

⇒

"1.8.1.0"

Sample uom library read command:

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

⇒

"1.8.1.0"

Browse more samples

Bootloader ID

string	config/bootloader_id/
Hash of bootloader

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

⇒

"0ee5052705e929576bb4f92398c22c516b5c990ee9eb95561c80ce7b38419bdc"

Sample JS request read command:

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

⇒

"c9388d830ccf43066c7947a1f7220dc830c0561264e10f034c0c4a3e6b1c13f4"

Browse more samples

ART ID

string	config/art_id/
Hash of ART settings

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

⇒

'2ec19303b2f4c352fa94f9649176b07a873da693350c405c17875f6ff9c8ed13'

Sample curl read command:

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

⇒

"0f1dcf621599eaa357aa23ab623fdd134310a0fd41041c7f15bbf2258818e5fa"

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

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

⇒

'EPCR5'

Sample curl read command:

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

⇒

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

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

⇒

"EPCR62203123456"

Sample curl read command:

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

⇒

"EPCR62203123456"

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

uom get "config/outlet_label"

⇒

"Outlet"

Sample JS request read command:

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

⇒

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

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

⇒

"Digital Loggers, Inc."

Sample requests read command:

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

⇒

'Digital Loggers, Inc.'

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

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

⇒

'Ethernet Power Controller'

Sample CLI read command:

uom get "config/brand_name"

⇒

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

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

⇒

'http://baz.example.com:8089/bar/quux/bar.html'

Sample curl read command:

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

⇒

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

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

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

⇒

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

Sample JS request read command:

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

⇒

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

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

uom get "config/brand_faq_url"

⇒

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

Sample uom library read command:

print(uom.dump(uom.config.brand_faq_url))

⇒

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

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

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

⇒

'https://bar.example.com:8443/foo/foo.html'

Sample curl read command:

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

⇒

"https://bar.example.com/bar.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 requests read command:

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

⇒

'support@example.com'

Sample uom library read command:

print(uom.dump(uom.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 uom library read command:

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

⇒

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

Sample requests read command:

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

⇒

'https://foo.example.com/quux/foo.html'

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

print(uom.dump(uom.config.support_url))

⇒

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

Sample JS request read command:

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

⇒

"http://baz.example.com/foo/baz/bar/baz/quux/baz/baz/baz/quux.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/"

⇒

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

Sample requests read command:

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

⇒

'http://foo.example.com/baz/baz/quux/quux/quux/bar/foo/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 curl read command:

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

⇒

"Whatever Systems Inc."

Sample JS request write command:

request.put({url:"config/custom_brand_company_name/",body:"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 curl read command:

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

⇒

"Amazing Controller III"

Sample uom library read command:

print(uom.dump(uom.config.custom_brand_name))

⇒

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

requests.put('http://192.168.0.100/restapi/config/custom_brand_url/',auth=auth,headers=headers,json='http://bar.example.com:1/quux/foo/bar/baz.html')

Sample JS request read command:

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

⇒

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

Browse more samples

Custom brand logo URL, if any

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

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

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

⇒

"https://foo.example.com:28443/baz/foo/foo/foo/baz/foo/bar/quux.png"

Sample requests write command:

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

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

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

⇒

22

Sample CLI read command:

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

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

⇒

32

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

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

Sample CLI write command:

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

Browse more samples

Custom registration URL, if any

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

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

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

⇒

'https://baz.example.com/foo/foo/baz.htm'

Sample curl read command:

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

⇒

"https://bar.example.com:18443/quux/foo.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 JS request read command:

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

⇒

"http://foo.example.com:7/foo/foo.htm"

Sample curl read command:

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

⇒

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

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

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

Sample uom library write command:

uom.config.custom_update_url="https://foo.example.com/quux/foo/quux.html"

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

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

⇒

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

Sample requests write command:

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

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

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

Sample requests read command:

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

⇒

None

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

uom set "config/registration_status" "false"

Sample curl write command:

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

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

uom.config.refresh_enabled=false

Sample curl write command:

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

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

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

⇒

1

Sample uom library write command:

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

uom get "config/image_format"

⇒

"gif"

Sample requests read command:

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

⇒

'png'

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

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

⇒

'bar.example.com'

Sample curl read command:

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

⇒

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

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

⇒

"UTC"

Sample requests read command:

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

⇒

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

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

⇒

[{'port': 8086, 'address': '192.168.0.8'}, {'port': 80, 'address': '192.168.0.4'}, {'port': 1, 'address': '192.168.0.59'}, {'port': 8047, 'address': '192.168.0.7'}, {'port': 8066, 'address': '192.168.0.8'}, {'port': 80, 'address': '192.168.0.7'}]

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[{\"port\":8099,\"address\":\"192.168.0.85\"},{\"port\":7,\"address\":\"192.168.0.9\"},{\"port\":80,\"address\":\"192.168.0.47\"},{\"port\":6,\"address\":\"192.168.0.9\"},{\"port\":8085,\"address\":\"192.168.0.4\"}]" "http://192.168.0.100/restapi/config/http_ports/"

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

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

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

uom.config.http_ports[_port_binding_index]={address="192.168.0.9",port=8021}

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

uom.config.http_ports[_port_binding_index].address="192.168.0.8"

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

uom set "config/http_ports/${port_binding_index}/address" "\"192.168.0.45\""

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 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/http_ports/:port_binding_index/port/"

⇒

80

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

uom.config.http_ports[_port_binding_index].port=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 CLI port binding creation command:

uom insert "config/https_ports/1" "{\"port\":8443,\"address\":\"192.168.0.2\"}"

Sample uom library write command:

uom.config.https_ports={{address="192.168.0.65",port=443}}

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

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

⇒

{'port': 8443, 'address': '192.168.0.69'}

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

⇒

{"port":8443,"address":"192.168.0.74"}

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 write command (note that :port_binding_index is a URL template argument):

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

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

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

⇒

'192.168.0.9'

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

⇒

443

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

uom.config.https_ports[_port_binding_index].port=443

Browse more samples

Custom HTTPS TLS cipher list, if any

sum (optional string)	config/https_tls_ciphers/
A colon-separated TLS cipher list to use for HTTPS instead of the default one, 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 can assume the following values:

constant null	Default	Use default TLS ciphers
string	Custom HTTPS TLS cipher list	A colon-separated TLS cipher list to use for HTTPS instead of the default one	the value is not equal to ""

Sample requests read command:

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

⇒

None

Sample CLI read command:

uom get "config/https_tls_ciphers"

⇒

"DHE-RSA-AES128-GCM-SHA256"

Browse more samples

Expand a TLS cipher list

call	config/expand_tls_ciphers/
Return descriptions of supported ciphers defined by a given TLS cipher list (if the result is empty, the cipher list is invalid and/or unsupported)

The call accepts the following arguments:

1. HTTPS TLS cipher list, if any: Default or HTTPS TLS cipher list

The call returns the following results:

1. TLS cipher list: array of "object "TLS cipher""

Sample CLI invocation:

uom invoke "config/expand_tls_ciphers" "\"ALL\""

⇒

Sample curl invocation:

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[\"SOME-INVALID-CIPHER\"]" "http://192.168.0.100/restapi/config/expand_tls_ciphers/"

⇒

[]

Browse more samples

HTTPS TLS cipher list, if any

sum (optional string)	config/expand_tls_ciphers/arguments: 1/
A colon-separated TLS cipher list, if any

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant null	Default	Default TLS cipher list
string	HTTPS TLS cipher list	A colon-separated TLS cipher list	the value is not equal to ""

TLS cipher list

array	config/expand_tls_ciphers/results: 1/
A list of TLS cipher descriptions

This array does not correspond to an actual resource.

This array contains TLS cipher elements.

See also TLS cipher list: TLS cipher

TLS cipher list: TLS cipher

object	config/expand_tls_ciphers/results: 1/N/
TLS cipher description

This object does not correspond to an actual resource.

This object contains the following items:

name	Name
description	Description
version	TLS version
bits	Bits
algbits	Algorithm bits

Name

string	config/expand_tls_ciphers/results: 1/N/name/
Cipher name

This string does not correspond to an actual resource.

Description

string	config/expand_tls_ciphers/results: 1/N/description/
Textual cipher description

This string does not correspond to an actual resource.

TLS version

string	config/expand_tls_ciphers/results: 1/N/version/
Version of TLS used

This string does not correspond to an actual resource.

Bits

number	config/expand_tls_ciphers/results: 1/N/bits/
Number of secret bits actually used for cipher

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

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

This number does not correspond to an actual resource.

Algorithm bits

number	config/expand_tls_ciphers/results: 1/N/algbits/
Number of secret bits generally supported by the algorithm

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

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

This number does not correspond to an actual resource.

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
automatic_renewal_period_ratio	Automatic renewal period ratio
automatic_renewal_min_overlap_time	Automatic renewal certificate minimum validity overlap
automatic_renewal_max_overlap_time	Automatic renewal certificate maximum validity overlap
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
automatic_renewal_scheduled_at	Automatic renewal scheduled time, if any
known_dn_oids	Known DN OIDs
known_renewal_methods	Renewal methods

Sample curl write command:

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

Sample CLI read command:

uom get "config/https_cert"

⇒

...

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

uom.config.https_cert.bits=8192

Sample requests write command:

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

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

request.put({url:"config/https_cert/distinguished_name/",body:{"commonName":["Digital Loggers Unit"],"countryName":["US"],"stateOrProvinceName":["California"],"localityName":["Santa Clara"]}});

Sample JS request values creation command:

request.put({url:"config/https_cert/distinguished_name/stateOrProvinceName/",body:["California"]});

Browse more samples

See also Distinguished name: Values

String mask

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

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

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

⇒

["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 JS request write command:

request.put({url:"config/https_cert/addresses/",body:null});

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/https_cert/addresses/',auth=auth,headers=headers,json=['101.3.253.6'])

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

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

⇒

false

Sample requests read command:

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

⇒

True

Browse more samples

Automatic renewal period ratio

number	config/https_cert/automatic_renewal_period_ratio/
Desired fraction of certificate validity time to wait before automatic renewal

The value represents ratio, which is dimensionless.

To convert to percents, multiply by 100.

To convert from percents, divide by 100.

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

• the value is greater or equal to 0
• the value is less or equal to 1

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample CLI read command:

uom get "config/https_cert/automatic_renewal_period_ratio"

⇒

0.6

Sample JS request write command:

request.put({url:"config/https_cert/automatic_renewal_period_ratio/",body:0.6});

Browse more samples

Automatic renewal certificate minimum validity overlap

number	config/https_cert/automatic_renewal_min_overlap_time/
Minimum certificate validity interval overlap for automatic renewal

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

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

⇒

115200

Sample requests write command:

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

Browse more samples

Automatic renewal certificate maximum validity overlap

number	config/https_cert/automatic_renewal_max_overlap_time/
Maximum certificate validity interval overlap for automatic renewal

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

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

⇒

504000

Sample JS request read command:

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

⇒

820800

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

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

⇒

"acmev2"

Sample curl write command:

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

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

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

⇒

"-----BEGIN CERTIFICATE REQUEST-----\nMIIZu7x7SAoF93DHZnEPSyxhdNJXi1+fMEcMjQjYyUSBr7bc/uv+bRsIgGcwHQ7H\nM4ICngZidG+EOB9W0urxi7CMF0ytikZzJwZus+3hySUffVEiSdXPEqMhAmU8TSv6\n79lZuXljgC2/\n-----END CERTIFICATE REQUEST-----\n"

Sample curl read command:

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

⇒

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

uom set "config/https_cert/cert" "\"-----BEGIN CERTIFICATE-----\\nMII5fQBw6sHmm9gzNFGruuOtjC1potMOu0PJHtqDtD0uRvcH+kPbWDXxCLfgnM5w\\naqwTBHTfi3pBO9Ay4Z5CJiVtvZedxqEwmXYdvYIFikxcvziG5sf5zPoAXmnPa7eX\\nsrkNDPGsduDq4tSl5YQAM5B3cB8wLY+4sxl4lzxoUCp/SBJ6ZGqTGIEoqe2zX15t\\nY40owgVkqM+LVx4X4OSx7clpE+tZNCOz8kiVMaBTFLJNgWPznYLdxIcDhDhoJTkD\\nWspDYgL3nG4vryLlob37AheVpn+7n+jUMcSsxAak4x9SvHiyZPi4p8Edru+8ZOHk\\nGW2brK9AvZx/Q3W9GNJphlGiXKrb8TVjqXTJju1PpS0HBVt3Ihjml1Ie\\n-----END CERTIFICATE-----\\n\""

Sample curl read command:

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

⇒

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

uom set "config/https_cert/key" "\"-----BEGIN PRIVATE KEY-----\\nMII1KOu7o1J/92o4Rc+9Wt3jUc5U5IoTo0WjUfmdG/SBqbaFKyvRlkJRfZCJi1E0\\nU/N6CQ8FROm2WMh8/hx/KDPcyP6jJ45c6iu+LHgTlW0IVBg0482GgAFGWkMIKUqu\\nd+XowTYVdS9Obeyl28DpwvAQgAm6NZ5su/5UdK3ex0BFZkpXq2vHte9py9XEmgIT\\n6BmFRJXL968v+HTyc84T5HkzNO2ql7Ke22lMRyeWFmgd2EBtba/Okj8QaMVL2csz\\nDxwbJVQBElCoZuM/r0bpVTdBmvbEZxLiJYU7aFtjmDEy4KZdc6gdIal8Q6PVTPdM\\nkxhLZT+MamM5lgvN3wtlm+T1hRcHEcfvbVtRt+j7F8hz9QbxrYJGKmmQKfJ64sV6\\n19yGRkQrclM/2NM+aF/BT6jzTPbo9I8GmxtLvpJOaH+8x2qXWZT2z2CVU8PtTwyh\\nWO/n+FduyeQdURTRAKQNCG+1sqdT3oAr5u3ITi2ooXBaasLLIxJLQ==\\n-----END PRIVATE KEY-----\\n\""

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"-----BEGIN PRIVATE KEY-----\\nMIIi2Bw5yeBuA0o0VqZPjjdfRL4eh5lX2DQ2l3J6tn1U4CquyxReZyxXx9lgB6yA\\nyQbeSjNu992jIjYj/kBF0BWVJ1MF9E0J4m72DjHOiXpwYPCQlfZ2hvKtgwsJrykL\\nXeUn7r4/uu3L8ahTEf1W8mVjBLQOAXOf0VJz5oXm=\\n-----END PRIVATE KEY-----\\n\"" "http://192.168.0.100/restapi/config/https_cert/key/"

Browse more samples

See also HTTPS certificate settings: Renew certificate

See also HTTPS certificate settings: Generate key

Automatic renewal scheduled time, if any

sum (optional number)	config/https_cert/automatic_renewal_scheduled_at/
Currently scheduled automatic renewal time, as determined by times derived from renewal period ratio and overlap time, whichever comes later, if any

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

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

This sum can assume the following values:

constant null	Automatic renewal not scheduled	Automatic renewal not enabled, and thus not scheduled
number	Automatic renewal scheduled time	Currently scheduled automatic renewal time, as determined by times derived from renewal period ratio and overlap time, whichever comes later

Sample requests read command:

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

⇒

1553299956

Sample uom library read command:

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

⇒

1560192802

Browse more samples

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

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

⇒

<...>

Sample CLI read command:

uom get "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 requests value creation command (note that _values is a variable):

requests.post('http://192.168.0.100/restapi/config/https_cert/distinguished_name/'+_values+'/',auth=auth,headers=headers,json='US')

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

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

⇒

["California"]

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 uom library deletion command (note that _values and _value_index are variables):

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

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

request.delete({url:"config/https_cert/distinguished_name/"+_values+"/"+_value_index.toString()+"/"});

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 "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"baz.example.com\"" "http://192.168.0.100/restapi/config/https_cert/domains/"

Sample CLI hostname creation command:

uom insert "config/https_cert/domains/0" "\"foo.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 CLI write command (note that hostname_index is a variable):

uom set "config/https_cert/domains/${hostname_index}" "\"baz.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,6,"11.1.76.161")

Sample curl IPv4 address creation command:

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

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

uom set "config/https_cert/addresses/${ipv4_address_index}" "\"2.9.22.252\""

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

request.put({url:"config/https_cert/addresses/"+_ipv4_address_index.toString()+"/",body:"240.115.29.254"});

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 JS request data item creation command:

request.put({url:"config/https_cert/renewal_data/acmev1_url/",body:"http://%0EEM]"});

Sample JS request write command:

request.put({url:"config/https_cert/renewal_data/",body:{"acmev2_agreement":" @","acmev2_contacts":" ]]","acmev2_auth_algorithm":"ES512","acmev2_url":"https://b]%CF]R]"}});

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

requests.put('http://192.168.0.100/restapi/config/https_cert/renewal_data/'+_data_item+'/',auth=auth,headers=headers,json='https://]]4]')

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

⇒

"6"

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 curl invocation:

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

⇒

null

Sample CLI invocation:

uom invoke "config/https_cert/renew_cert"

⇒

null

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 curl invocation:

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

⇒

null

Sample requests invocation:

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

⇒

None

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

uom get "config/https_cert/known_dn_oids"

⇒

Sample uom library read command:

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

⇒

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

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

⇒

"2.5.4.42"

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

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

⇒

"2.5.4.17"

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 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":"^https://(]|[!#&'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))+$","name":"EST server base URL (not including .well-known/...; secure transport required)","secret":false}

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

⇒

{'regexp': '^https?://(]|[!#&\'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))+$', 'name': 'ACMEv1 directory endpoint URL', 'secret': False}

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

⇒

"Number of days to issue new certificates for"

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

⇒

'ACMEv2 service agreement'

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 JS request read command (note that _renewal_method and _data_item_properties are variables):

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

⇒

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

Sample curl read command (note that :renewal_method and :data_item_properties are URL template arguments):

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

⇒

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

Browse more samples

Secret

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

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

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

⇒

false

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

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

⇒

False

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

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

⇒

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

requests.put('http://192.168.0.100/restapi/config/https_cert/known_renewal_methods/'+_renewal_method+'/',auth=auth,headers=headers,json={'name': 'Obtain a certificate from an ACME v1 endpoint (e.g. Let\'s Encrypt)', 'data_items': {'acmev1_key_size': {'regexp': '^[1-9][0-9]*$', 'name': 'ACMEv1 default account key size in bits', 'secret': False}, 'acmev1_url': {'regexp': '^https?://(]|[!#&\'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))+$', 'name': 'ACMEv1 directory endpoint URL', 'secret': False}, 'acmev1_agreement': {'regexp': '^((]|[!#&\'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))| )+$', 'name': 'ACMEv1 service agreement', 'secret': False}, 'acmev1_key_type': {'regexp': '^(rsa|dsa|dh)$', 'name': 'ACMEv1 default account key type', 'secret': False}, 'acmev1_contacts': {'regexp': '^((]|[!#&\'()*+,/:;=?@[$A-Za-z0-9._~-]|(%[0-9A-Fa-f][0-9A-Fa-f]))| )+$', 'name': 'ACMEv1 contact URLs, whitespace-separated', 'secret': False}}})

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

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

⇒

"Obtain a certificate via EST (Enrollment over Secure Transport)"

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 via EST (Enrollment over Secure Transport)"

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

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

⇒

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

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

⇒

Sample curl read command:

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

⇒

Browse more samples

See also Certificate collection: Certificate

Certificate collection: Certificate

object	config/certificates/S/
Certificate settings

The value is subject to the following constraints: index of 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 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
custom	Custom flag

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

uom get "config/certificates/${certificate}"

⇒

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

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

⇒

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

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"-----BEGIN CERTIFICATE-----\\nMIIGv9hyN8aqaEjZmf0DS4p9r3fChBfc9VLD8C5At5izD5Oe4k/ywEh8Uw253ckq\\nFJqxVXOzgBtWuFeW1wZGMbTDNh9zqDgGhM/4FWpG8YPXlxcU4Fd9z77pY8SAptBl\\nfa5ys8HgRLDT8HRns5WzrkwxC4AE240wFlg=\\n-----END CERTIFICATE-----\\n\"" "http://192.168.0.100/restapi/config/certificates/:certificate/data/"

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

uom get "config/certificates/${certificate}/data"

⇒

"-----BEGIN CERTIFICATE-----\nMIIRZu4DInlWMZJ0F9UoxWKsSS681aJ0YSMJxu1WlNRYQkwlLmLVu7F111oBrSE0\n+wV1IojWfQNbTnKgXSedavjILOOs3RtRODIj+uP6hWAF1z++CRORPD3Bx+sRAFab\nrGN033+uZUcrvD8JhrQ=\n-----END CERTIFICATE-----\n"

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

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

⇒

false

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

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

⇒

True

Browse more samples

Custom flag

sum (boolean)	config/certificates/S/custom/
Flag indicating whether the certificate is custom

The value is unconditionally set to true on creation and doesn't have to be supplied (if it is, it must match)

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Custom	The certificate has no match in the current factory firmware (it could be left over from a previous version)
constant false	Built-in	The certificate is present in the current factory firmware

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

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

⇒

false

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

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

⇒

true

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 requests certificate revocation list creation command:

requests.put('http://192.168.0.100/restapi/config/crls/iSecureBazCrypt_Root_Certification_Authority/',auth=auth,headers=headers,json={'status': True, 'data': '-----BEGIN X509 CRL-----\nMIICbbwbGzNTvZcDBIqn6v/tVG5tKY0ZZD0vbNaYCrE+bptdR35XMY0EhBFXJckR\nudYcX4vW1ABM+3/oRJdllCXxc9Trs+/N7Mql33x62D08TMGva0LX++iXtJsu4+ZV\nzgRDTTgFTcmujIw0ym5w5PrLWwZVmeJlOPN8PH6aHnktJHVH\n-----END X509 CRL-----\n'})

Sample uom library read command:

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

⇒

Browse more samples

See also Certificate revocation list collection: Certificate revocation list

Certificate revocation list collection: Certificate revocation list

object	config/crls/S/
Certificate revocation list settings

The value is subject to the following constraints: index of 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 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
custom	Custom flag

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

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"status\":false,\"data\":\"-----BEGIN X509 CRL-----\\nMIIdGl3syJJEQenWCk9BJTrBP8D5Wq+Oap4c7kQ0tEHLwmBm1Cv7JDAtk5BQ5pdx\\n434K3qul+35nJBG72lWepocjqXBvTU9YcEKRJnHLqIEufyhIw2q2aIzi4Nwyy/BH\\n2e0fZiIbgikncB6I0cCXZEgjWK2O4LxFR+Az+iwvqQaBAY+mAZolsZjPe3tztSqQ\\nmre4SNq9pvXlIGFTg7l4ADFK6B47wXPnFPmQx+ylP==\\n-----END X509 CRL-----\\n\"}" "http://192.168.0.100/restapi/config/crls/:certificate_revocation_list/"

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

uom.remove(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 CLI read command (note that certificate_revocation_list is a variable):

uom get "config/crls/${certificate_revocation_list}/data"

⇒

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

request.put({url:"config/crls/"+_certificate_revocation_list+"/data/",body:"-----BEGIN X509 CRL-----\nMIICdFiG6ohX3mDyrJgXFj/y+jj4yM0imBAApDpAlRSIeqUhz6NhZtEpw0w9A6St\ntqaHamkWIIialTUjctNsDyeP3qohZC+/zGuLQtT/FBC49DQPozurXF8Hzb+Gh0u+\nRMMHaUzPxHjqaxJ+v3qmAu8WbGU2W+Tj9jVQazGv/Grg1rNAyTNvC3yqNpyrnhrH\noTRrdlWNtTi8FdHn+DPvVIjo8+7RYqrGU1R1TbY/QZJtS5r64q3MRqX+YAHHuVMt\njPr2EPNBzp4nYQvHhRNqEoq2wJS26LMeKU2cmSuYBMEFEamIvh699D9Y7d1fcyqo\nns2mk1QKVVa+fYFPKqVchnbyIEmhg7G29ooBM1Aqx0lqZjbGwzAYqlpLPUTaWAcY\nI26g8yHkQFhG/kdXQXSBHB5MkTYwzDnnQacD4KqDUwk/GsTKzMGlCXP7zakJJzgD\nfePMA98xp9hfUsoSPUuf=\n-----END X509 CRL-----\n"});

Browse more samples

Usage status

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

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

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

⇒

false

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

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

Browse more samples

Custom flag

sum (boolean)	config/crls/S/custom/
Flag indicating whether the certificate revocation list is custom

The value is unconditionally set to true on creation and doesn't have to be supplied (if it is, it must match)

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Custom	The certificate revocation list has no match in the current factory firmware (it could be left over from a previous version)
constant false	Built-in	The certificate revocation list is present in the current factory firmware

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

⇒

True

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

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

⇒

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

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

⇒

true

Sample curl read command:

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

⇒

false

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

request.put({url:"config/ssh_port/",body:8022});

Sample requests write command:

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

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

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

⇒

[{"data":"ecdsa-sha2-nistp256     XYJ8x+3MaQC=","options":"","comment":""}]

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/ssh_authorized_keys/',auth=auth,headers=headers,json=[{'data': 'ssh-ed25519   9===', 'options': '', 'comment': 'elybnft'}, {'data': 'ecdsa-sha2-nistp384 0uP===', 'options': '', 'comment': 'vpq'}])

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

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

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': 'ssh-ed25519  xzI===', 'options': 'os=0565562,x,kt=zhj,lp,zckwfnr=3183', '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 uom library read command (note that _ssh_authorized_key_index is a variable):

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

⇒

"ecdsa-sha2-nistp256  sT1="

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

requests.put('http://192.168.0.100/restapi/config/ssh_authorized_keys/'+str(_ssh_authorized_key_index)+'/data/',auth=auth,headers=headers,json='ssh-ed25519       7oUF=')

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

⇒

"olrm=5,zcvuinmwf=kz"

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()+"/options/",body:"v=hztuuiph,dm=5649,wit=7891,czc=829989"});

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

print(requests.get('http://192.168.0.100/restapi/config/ssh_authorized_keys/'+str(_ssh_authorized_key_index)+'/comment/',auth=auth,headers=headers).json())

⇒

''

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

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

⇒

""

Browse more samples

Enable SSH password authentication

sum (boolean)	config/ssh_password_auth_enabled/
Whether the SSH password authentication 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 uom library read command:

print(uom.dump(uom.config.ssh_password_auth_enabled))

⇒

true

Sample CLI write command:

uom set "config/ssh_password_auth_enabled" "true"

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

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

⇒

true

Sample JS request write command:

request.put({url:"config/ntp_server_enabled/",body: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 curl read command:

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

⇒

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

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

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])$
string	IPv6 address	IPv6 address in colon notation	the value matches ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$

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

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

⇒

"1.ntp-pool.example.com"

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

uom set "config/ntp_peers/${ntp_peer_index}" "\"2.ntp-pool.example.com\""

Browse more samples

Syslog threshold severity

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

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

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

Sample curl read command:

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

⇒

8

Browse more samples

Syslog server address, if any

sum (optional string)	config/syslog_ip_address/
Host name or IP 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])$
string	IPv6 address	IPv6 address in colon notation	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 JS request write command:

request.put({url:"config/syslog_ip_address/",body:null});

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

uom get "config/allow_jsonrpc"

⇒

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

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

Sample requests read command:

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

⇒

False

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

uom set "config/allow_restapi" "true"

Sample requests read command:

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

⇒

False

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

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

Sample CLI read command:

uom get "config/allow_restapi_nonadmin"

⇒

false

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 represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).

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

Sample uom library read command:

print(uom.dump(uom.config.allow_restapi_origins))

⇒

{"https://bar.example.com:38443","http://bar.example.com:9","https://baz.example.com","http://foo.example.com","http://bar.example.com"}

Sample requests write command:

requests.put('http://192.168.0.100/restapi/config/allow_restapi_origins/',auth=auth,headers=headers,json=['http://baz.example.com:9', 'http://foo.example.com', 'https://bar.example.com', 'https://foo.example.com:58443', '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

The value is subject to the following constraints: the value matches ^[a-zA-Z][a-zA-Z0-9+.-]*://((([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])?)|(([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])|(([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])))(:[1-9][0-9]*)?$

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

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

request.delete({url:"config/allow_restapi_origins/"+_allowed_rest_like_api_client_origin_index.toString()+"/"});

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

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

⇒

'http://foo.example.com:9'

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

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

Sample uom library write command:

uom.config.allow_coapws=false

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

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

⇒

false

Sample curl read command:

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

⇒

true

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 represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).

This array contains Allowed CoAP over WebSockets client origin elements.

Sample JS request allowed CoAP over WebSockets client origin creation command:

request.post({url:"config/allow_coapws_origins/",body:"https://bar.example.com:443"});

Sample CLI read command:

uom get "config/allow_coapws_origins"

⇒

["https://foo.example.com","http://baz.example.com:8004","https://bar.example.com","https://foo.example.com:443","https://foo.example.com:28443"]

Browse more samples

Allowed CoAP over WebSockets client origin

string	config/allow_coapws_origins/N/
Origin permitted to access CoAP over WebSockets

The value is subject to the following constraints: the value matches ^[a-zA-Z][a-zA-Z0-9+.-]*://((([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])?)|(([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])|(([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])))(:[1-9][0-9]*)?$

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

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

uom remove "config/allow_coapws_origins/${allowed_coap_over_websockets_client_origin_index}"

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

⇒

'http://baz.example.com:2'

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

uom get "config/relax_nonhtml_methods"

⇒

true

Sample uom library read command:

print(uom.dump(uom.config.relax_nonhtml_methods))

⇒

false

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

uom.config.relax_nonhtml_content_types=true

Sample requests read command:

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

⇒

True

Browse more samples

Allow plaintext logins

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

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

Sample JS request write command:

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

Sample curl write command:

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

Browse more samples

Allow plaintext URL logins

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

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

Sample uom library write command:

uom.config.allow_plaintext_url_logins={}

Sample uom library read command:

print(uom.dump(uom.config.allow_plaintext_url_logins))

⇒

{}

Browse more samples

Allow state-changing GET requests

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

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

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

Sample JS request write command:

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

Browse more samples

Allowed HTTP hostnames

array	config/allow_http_hostnames/
List of permitted hostnames that can be used to address the unit in the Host header

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 represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).

This array contains Allowed HTTP hostname pattern elements.

Sample CLI write command:

uom set "config/allow_http_hostnames" "[\"${hostname}.foo.example.com\",\"*\"]"

Sample JS request read command:

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

⇒

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

Browse more samples

Allowed HTTP hostname pattern

string	config/allow_http_hostnames/N/
Permitted hostname pattern (*: any sequence of characters, ${hostname}: the current hostname)

Retrieving the value is denied if not administrative user

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

• not administrative user
• protect network settings

This string represents a value in persistent storage.

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

uom.remove(uom.config.allow_http_hostnames,_allowed_http_hostname_pattern_index)

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

uom get "config/allow_http_hostnames/${allowed_http_hostname_pattern_index}"

⇒

"*"

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

uom.config.name_always_visible=false

Sample curl read command:

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

⇒

false

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

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

Sample curl write command:

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

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

print(uom.dump(uom.config.hide_wifi_key))

⇒

false

Sample JS request write command:

request.put({url:"config/hide_wifi_key/",body: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 curl write command:

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

Sample curl read command:

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

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

⇒

true

Sample requests read command:

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

⇒

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

uom set "config/protect_admin" "false"

Sample JS request read command:

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

⇒

true

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

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

Sample uom library write command:

uom.config.protect_network=false

Browse more samples

Protect private settings

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

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

⇒

true

Sample uom library read command:

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

⇒

false

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

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

⇒

false

Sample curl write command:

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

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

uom.config.protect_maintenance=true

Sample requests read command:

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

⇒

False

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

⇒

true

Sample requests read command:

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

⇒

False

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

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

⇒

true

Sample curl read command:

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

uom.config.upgrade_notify_blink=false

Sample uom library read command:

print(uom.dump(uom.config.upgrade_notify_blink))

⇒

false

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

uom get "config/known_quantities"

⇒

...

Sample curl read command:

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

⇒

...

Browse more samples

Quantity

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

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

⇒

{'preferred_unit': None, 'name': 'Illuminance', 'units': {'lx': {'offset': 0, 'internal': True, 'name': 'lux', 'scale': 1}, 'fc': {'offset': 0, 'internal': True, 'name': 'foot-candle', 'scale': 0.09290226681531}}}

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

print(uom.dump(uom.config.known_quantities[_quantity]))

⇒

{name="Ratio",preferred_unit="%",units={["%"]={internal=true,name="percent",offset=0,scale=100},times={internal=true,name="",offset=0,scale=1}}}

Browse more samples

See also Quantity: Name

See also Quantity: Known units

See also Quantity: Preferred unit, if any

Quantity: Name

string	config/known_quantities/S/name/
Quantity name

This string does not support direct modification.

This string represents a value in persistent storage.

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

print(uom.dump(uom.config.known_quantities[_quantity].name))

⇒

"Voltage"

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

uom get "config/known_quantities/${quantity}/name"

⇒

"Voltage"

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 unit creation command (note that _quantity is a variable):

local composite=uom.copy(uom.config.known_quantities[_quantity].units)
uom.insert(composite,"s",{name="second",offset=0,scale=1})
uom.config.known_quantities[_quantity].units=composite

Sample curl unit creation command (note that :quantity is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"offset\":0,\"internal\":false,\"name\":\"pixel\",\"scale\":1}" "http://192.168.0.100/restapi/config/known_quantities/:quantity/units/px/"

Browse more samples

Unit

object	config/known_quantities/S/units/S/
Unit of physical quantity

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

Changing the value is denied if not administrative user

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

This object does not support direct modification if internal.

This object represents a value in persistent storage.

This object contains the following items:

name	Name
scale	Scaling factor
offset	Offset
internal	Internal

Sample curl read command (note that :quantity and :unit are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/known_quantities/:quantity/units/:unit/"

⇒

{"offset":0,"internal":true,"name":"joule","scale":1}

Sample uom library deletion command (note that _quantity and _unit are variables):

local composite=uom.copy(uom.config.known_quantities[_quantity].units)
uom.remove(composite,_unit)
uom.config.known_quantities[_quantity].units=composite

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"

⇒

"time"

Sample curl read command (note that :quantity and :unit are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/known_quantities/:quantity/units/:unit/name/"

⇒

"ampere"

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 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "1.8" "http://192.168.0.100/restapi/config/known_quantities/:quantity/units/:unit/scale/"

Sample JS request write command (note that _quantity and _unit are variables):

request.put({url:"config/known_quantities/"+_quantity+"/units/"+_unit+"/scale/",body: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 curl read command (note that :quantity and :unit are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/known_quantities/:quantity/units/:unit/offset/"

⇒

0

Sample uom library read command (note that _quantity and _unit are variables):

print(uom.dump(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 JS request read command (note that _quantity and _unit are variables):

request.get({url:"config/known_quantities/"+_quantity+"/units/"+_unit+"/internal/"},function(error,response,body) {console.log(body)});

⇒

true

Sample uom library read command (note that _quantity and _unit are variables):

print(uom.dump(uom.config.known_quantities[_quantity].units[_unit].internal))

⇒

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

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

⇒

"C"

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

uom get "config/known_quantities/${quantity}/preferred_unit"

⇒

"J"

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

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

⇒

Sample requests read command:

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

⇒

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

uom get "config/known_timezones/${timezone}"

⇒

"UTC-11"

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

print(uom.dump(uom.config.known_timezones[_timezone]))

⇒

"UTC-3"

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

uom get "config/known_protection_bits"

⇒

Sample JS request read command:

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

⇒

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

uom set "config/known_protection_bits/${protection_bit}" "{\"name\":\"Firmware protection\",\"status\":\"You have enabled that and that service which allows to bypass this protection\"}"

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

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

⇒

{'name': 'Network settings 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 CLI read command (note that protection_bit is a variable):

uom get "config/known_protection_bits/${protection_bit}/name"

⇒

"Firmware protection"

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

print(uom.dump(uom.config.known_protection_bits[_protection_bit].name))

⇒

"Administrator credentials protection"

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

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

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

⇒

false

Browse more samples

Known component versions

map	config/known_component_versions/
Map of known component version ranges and their status

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 Component information elements.

Creating elements in this collection is not supported.

Sample CLI read command:

uom get "config/known_component_versions"

⇒

...

Sample JS request read command:

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

⇒

<...>

Browse more samples

Component information

object	config/known_component_versions/S/
Version information for a component

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

This object does not support direct modification.

This object represents a value in persistent storage.

This object contains the following items:

name	Name
path	Path
versions	Versions
unknown_version_warning	Unknown version warning

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

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

⇒

<...>

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

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

⇒

Browse more samples

See also Component information: Name

See also Component information: Path

See also Component information: Versions

See also Component information: Unknown version warning

Component information: Name

string	config/known_component_versions/S/name/
Component name

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

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

⇒

"Bootloader"

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

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

⇒

'AVR'

Browse more samples

Component information: Path

array	config/known_component_versions/S/path/
Component version path relative to object model root

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

This array does not support direct modification.

This array represents a value in persistent storage.

This array contains Path component elements.

Creating elements in this collection is not supported.

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

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

⇒

["relay","version"]

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

uom get "config/known_component_versions/${component_information}/path"

⇒

["relay","version"]

Browse more samples

Path component

sum (variant)	config/known_component_versions/S/path/N/
Element of component version path

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:

string	String	String path component
number	Number	Number path component

Sample uom library read command (note that _component_information and _path_component_index are variables):

print(uom.dump(uom.config.known_component_versions[_component_information].path[_path_component_index]))

⇒

"relay"

Sample CLI read command (note that component_information and path_component_index are variables):

uom get "config/known_component_versions/${component_information}/path/${path_component_index}"

⇒

"relay"

Browse more samples

Version match: Version match item

sum (variant)	config/known_component_versions/S/versions/N/1/N/
Condition for matching the version

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

This sum can assume the following values:

string	Exact match	Matches this exact version
tuple	Range match	Matches dot-separated versions in this range, including start but excluding end

Sample uom library write command (note that _component_information, _version_data_index and _version_match_item_index are variables):

uom.config.known_component_versions[_component_information].versions[_version_data_index][1][_version_match_item_index]="7ea3f7cdd2fa4ba0e105f9315813f5dd9088b5a9b9b7f138d36d9c2e4d3f00f3"

Sample CLI read command (note that component_information, version_data_index and version_match_item_index are variables):

uom get "config/known_component_versions/${component_information}/versions/${version_data_index}/0/${version_match_item_index}"

⇒

"ca8a56bf8a76b0d988579cbc02b0d46d899c81389368fb5e41d080c793c0f7cb"

Browse more samples

Range match

(possibly) tuple	config/known_component_versions/S/versions/N/1/N/
Matches dot-separated versions in this range, including start but excluding end

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

This tuple does not support direct modification.

This tuple represents a value in persistent storage.

This tuple contains the following items:

1	Range start, if any
2	Range end, if any

Browse more samples

Range start, if any

sum (optional string)	config/known_component_versions/S/versions/N/1/N/1/
Start of range to match (included), if any

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

This sum does not support direct modification.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	No range start limit	Match arbitrarily old versions
string	Range start	Start of range to match (included)

Sample requests read command (note that _component_information, _version_data_index and _version_match_item_index are variables):

print(requests.get('http://192.168.0.100/restapi/config/known_component_versions/'+_component_information+'/versions/'+str(_version_data_index)+'/0/'+str(_version_match_item_index)+'/0/',auth=auth,headers=headers).json())

⇒

'1.62.60.0'

Sample CLI read command (note that component_information, version_data_index and version_match_item_index are variables):

uom get "config/known_component_versions/${component_information}/versions/${version_data_index}/0/${version_match_item_index}/0"

⇒

null

Browse more samples

Range end, if any

sum (optional string)	config/known_component_versions/S/versions/N/1/N/2/
End of range to match (excluded), if any

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

This sum does not support direct modification.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	No range end limit	Match arbitrarily new versions
string	Range end	End of range to match (excluded)

Sample uom library read command (note that _component_information, _version_data_index and _version_match_item_index are variables):

print(uom.dump(uom.config.known_component_versions[_component_information].versions[_version_data_index][1][_version_match_item_index][2]))

⇒

"1.54.7.0"

Sample curl read command (note that :component_information, :version_data_index and :version_match_item_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/known_component_versions/:component_information/versions/:version_data_index/0/:version_match_item_index/1/"

⇒

null

Browse more samples

Issues: Issue

tuple	config/known_component_versions/S/versions/N/2/N/
Known issue description

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

This tuple does not support direct modification.

This tuple represents a value in persistent storage.

This tuple contains the following items:

1	Kind
2	Title
3	Description
4	Importance

Sample curl read command (note that :component_information, :version_data_index and :issue_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/config/known_component_versions/:component_information/versions/:version_data_index/1/:issue_index/"

⇒

["bug","Relay configuration issues","The outlet doesn't update",0.9]

Sample CLI read command (note that component_information, version_data_index and issue_index are variables):

uom get "config/known_component_versions/${component_information}/versions/${version_data_index}/1/${issue_index}"

⇒

["bug","Boot management timeouts","The GPIO doesn't configure",0.7]

Browse more samples

Kind

sum (enumerated string)	config/known_component_versions/S/versions/N/2/N/1/
Kind of issue

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 "bug"	Bug	Problem present in the version(s)
constant "missing-feature"	Missing feature	Feature not present in the version(s)

Sample CLI read command (note that component_information, version_data_index and issue_index are variables):

uom get "config/known_component_versions/${component_information}/versions/${version_data_index}/1/${issue_index}/0"

⇒

"bug"

Sample requests read command (note that _component_information, _version_data_index and _issue_index are variables):

print(requests.get('http://192.168.0.100/restapi/config/known_component_versions/'+_component_information+'/versions/'+str(_version_data_index)+'/1/'+str(_issue_index)+'/0/',auth=auth,headers=headers).json())

⇒

'missing-feature'

Browse more samples

Title

string	config/known_component_versions/S/versions/N/2/N/2/
Title of the issue

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 _component_information, _version_data_index and _issue_index are variables):

print(uom.dump(uom.config.known_component_versions[_component_information].versions[_version_data_index][2][_issue_index][2]))

⇒

"Outlet configuration support"

Sample CLI read command (note that component_information, version_data_index and issue_index are variables):

uom get "config/known_component_versions/${component_information}/versions/${version_data_index}/1/${issue_index}/1"

⇒

"Boot management issues"

Browse more samples

Description

string	config/known_component_versions/S/versions/N/2/N/3/
Textual description of the issue

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

This string does not support direct modification.

This string represents a value in persistent storage.

Sample JS request read command (note that _component_information, _version_data_index and _issue_index are variables):

request.get({url:"config/known_component_versions/"+_component_information+"/versions/"+_version_data_index.toString()+"/1/"+_issue_index.toString()+"/2/"},function(error,response,body) {console.log(body)});

⇒

"The outlet doesn't switch"

Sample CLI read command (note that component_information, version_data_index and issue_index are variables):

uom get "config/known_component_versions/${component_information}/versions/${version_data_index}/1/${issue_index}/2"

⇒

"The UART now switches"

Browse more samples

Importance

number	config/known_component_versions/S/versions/N/2/N/4/
Relative importance of the issue

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

This number does not support direct modification.

This number represents a value in persistent storage.

Sample uom library read command (note that _component_information, _version_data_index and _issue_index are variables):

print(uom.dump(uom.config.known_component_versions[_component_information].versions[_version_data_index][2][_issue_index][4]))

⇒

0.2

Sample requests read command (note that _component_information, _version_data_index and _issue_index are variables):

print(requests.get('http://192.168.0.100/restapi/config/known_component_versions/'+_component_information+'/versions/'+str(_version_data_index)+'/1/'+str(_issue_index)+'/3/',auth=auth,headers=headers).json())

⇒

1

Browse more samples

Component information: Versions

array	config/known_component_versions/S/versions/
List of known versions or ranges

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

This array does not support direct modification.

This array represents a value in persistent storage.

This array contains Version data elements.

Creating elements in this collection is not supported.

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

uom get "config/known_component_versions/${component_information}/versions"

⇒

...

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

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

⇒

Browse more samples

Version data

tuple	config/known_component_versions/S/versions/N/
Version information

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

This tuple does not support direct modification.

This tuple represents a value in persistent storage.

This tuple contains the following items:

1	Version match
2	Issues

Sample CLI read command (note that component_information and version_data_index are variables):

uom get "config/known_component_versions/${component_information}/versions/${version_data_index}"

⇒

Sample JS request read command (note that _component_information and _version_data_index are variables):

request.get({url:"config/known_component_versions/"+_component_information+"/versions/"+_version_data_index.toString()+"/"},function(error,response,body) {console.log(body)});

⇒

Browse more samples

Version match

array	config/known_component_versions/S/versions/N/1/
Conditions for matching the version

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

This array does not support direct modification.

This array represents a value in persistent storage.

This array contains Version match item elements.

Creating elements in this collection is not supported.

Sample uom library read command (note that _component_information and _version_data_index are variables):

print(uom.dump(uom.config.known_component_versions[_component_information].versions[_version_data_index][1]))

⇒

{"1.8.2.0",{"1.4.1.0","1.8.9.0"},{null,"1.38.98.0"},{"1.6.16.0","1.91.2.0"},{"1.3.30.0","1.10.6.0"},{"1.1.30.0",null}}

Sample JS request read command (note that _component_information and _version_data_index are variables):

request.get({url:"config/known_component_versions/"+_component_information+"/versions/"+_version_data_index.toString()+"/0/"},function(error,response,body) {console.log(body)});

⇒

["10a008c075e29a7d31ab9f5cbd933e7ebd361a0ceff24c7ced184ad6d4c44775","5717794a818becd8ddc902bbf241928fc71d08185245dbae829aa3169d1540b2"]

Browse more samples

See also Version match: Version match item

Issues

array	config/known_component_versions/S/versions/N/2/
Known issues with components in this range

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

This array does not support direct modification.

This array represents a value in persistent storage.

This array contains Issue elements.

Creating elements in this collection is not supported.

Sample requests read command (note that _component_information and _version_data_index are variables):

print(requests.get('http://192.168.0.100/restapi/config/known_component_versions/'+_component_information+'/versions/'+str(_version_data_index)+'/1/',auth=auth,headers=headers).json())

⇒

Sample JS request read command (note that _component_information and _version_data_index are variables):

request.get({url:"config/known_component_versions/"+_component_information+"/versions/"+_version_data_index.toString()+"/1/"},function(error,response,body) {console.log(body)});

⇒

Browse more samples

See also Issues: Issue

Component information: Unknown version warning

string	config/known_component_versions/S/unknown_version_warning/
Warning to display if version matched no entries

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

uom get "config/known_component_versions/${component_information}/unknown_version_warning"

⇒

"Boot, reboot, upgrade state conservation, power-up state restoration, etc. issues possible"

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

print(uom.dump(uom.config.known_component_versions[_component_information].unknown_version_warning))

⇒

"Boot, reboot, upgrade state conservation, power-up state restoration, etc. issues possible"

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

uom get "config/relay_ports"

⇒

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