object	network/
Data related to network state and configuration

Retrieving the value is denied if not administrative user

This object contains the following items:

wired	Wired network data
wireless	Wireless network data, if any
interface_order	Interface priority order
same_subnet_only	Same subnet restriction
known_protocols	Known protocols
notifications	Notifications

Sample curl write command:

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

Sample JS request write command:

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

Browse more samples

Wired network data

object	network/wired/
Data related to wired network state and configuration

Retrieving the value is denied if not administrative user

This object contains the following items:

mac_address	MAC address
online	Online
protocol	IP address assignment protocol
ip_address	IP address
netmask	Network mask
gateway	Default gateway IP address, if any
metric	Metric
dns_servers	DNS servers
serve_dns	DNS server

Sample uom library read command:

print(uom.dump(uom.network.wired))

⇒

{dns_servers={"57.87.27.25","220.9.134.9"},gateway="192.168.24.46",ip_address="192.168.24.63",mac_address="7C:E1:FF:A1:E3:FD",netmask="255.255.255.0",online=false,protocol="static",serve_dns=true}

Sample JS request write command:

request.put({url:"network/wired/",body:{"ip_address":"192.168.179.167","serve_dns":false,"protocol":"static","online":true,"gateway":"192.168.179.40","dns_servers":["158.230.136.78","242.201.131.123"],"mac_address":"7C:E1:FF:C2:0C:00","netmask":"255.255.255.0"}});

Browse more samples

MAC address

string	network/wired/mac_address/
MAC address to use for this interface

The value is subject to the following constraints: the value matches ^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample uom library write command:

uom.network.wired.mac_address="7C:E1:FF:B1:4A:50"

Sample curl write command:

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"7C:E1:FF:14:88:A9\"" "http://192.168.0.100/restapi/network/wired/mac_address/"

Browse more samples

Online

sum (boolean)	network/wired/online/
Flag indicating the interface online status

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

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

This sum can assume the following values:

constant true	Online	The interface is online
constant false	Offline	The interface is offline

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/wired/online/"

⇒

true

Sample requests read command:

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

⇒

True

Browse more samples

IP address assignment protocol

string	network/wired/protocol/
Method for obtaining an IP address for this interface

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample CLI write command:

uom set "network/wired/protocol" "\"dhcp\""

Sample uom library write command:

uom.network.wired.protocol="dhcp"

Browse more samples

IP address

string	network/wired/ip_address/
IP address to use for this interface

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

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

Changes to this string do not take effect immediately.

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/wired/ip_address/"

⇒

"10.1.204.131"

Sample JS request read command:

request.get({url:"network/wired/ip_address/"},function(error,response,body) {console.log(body)});

⇒

"10.23.163.184"

Browse more samples

Network mask

string	network/wired/netmask/
Network mask to use for this interface

The value is subject to the following constraints: the value matches ^((2(5[42]|4[80]|24)|192|128|0).0.0.0|255.(2(5[42]|4[80]|24)|192|128|0).0.0|255.255.(2(5[42]|4[80]|24)|192|128|0).0|255.255.255.(2(5[542]|4[80]|24)|192|128|0))$

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

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

Changes to this string do not take effect immediately.

Sample CLI read command:

uom get "network/wired/netmask"

⇒

"255.0.0.0"

Sample requests write command:

requests.put('http://192.168.0.100/restapi/network/wired/netmask/',auth=auth,headers=headers,json='255.0.0.0')

Browse more samples

Default gateway IP address, if any

sum (optional string)	network/wired/gateway/
The IP address to send packets which are not targeted to local networks, if any

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

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

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

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant null	No default gateway	Packets with nonlocal destination are dropped
string	Default gateway IP address	The IP address to send packets which are not targeted to local networks	the value matches ^(([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]).){3}([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])$

Sample requests read command:

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

⇒

'192.168.130.47'

Sample requests write command:

requests.put('http://192.168.0.100/restapi/network/wired/gateway/',auth=auth,headers=headers,json='10.0.0.42')

Browse more samples

Metric

number	network/wired/metric/
Cost associated with sending packets over this interface

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

the value is an integer
the value is greater or equal to 0
the value is less or equal to 4294967295

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Changes to this number do not take effect immediately.

Sample requests write command:

requests.put('http://192.168.0.100/restapi/network/wired/metric/',auth=auth,headers=headers,json={})

Sample uom library read command:

print(uom.dump(uom.network.wired.metric))

⇒

{}

Browse more samples

DNS server

sum (boolean)	network/wired/serve_dns/
Respond to DNS queries

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant true	Enabled	The feature is 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/network/wired/serve_dns/"

⇒

false

Sample JS request read command:

request.get({url:"network/wired/serve_dns/"},function(error,response,body) {console.log(body)});

⇒

false

Browse more samples

Wired network data: DNS servers

array	network/wired/dns_servers/
List of DNS server IP addresses

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This array represents a value in persistent storage.

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

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

Changes to this array do not take effect immediately.

This array contains DNS server elements.

Sample CLI DNS server creation command:

uom insert "network/wired/dns_servers/1" "\"83.132.226.22\""

Sample JS request DNS server creation command:

request.post({url:"network/wired/dns_servers/",body:"244.227.3.187"});

Browse more samples

DNS server

string	network/wired/dns_servers/N/
DNS server IP address

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

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

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/wired/dns_servers/:dns_server_index/"

⇒

"126.9.146.80"

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

print(requests.get('http://192.168.0.100/restapi/network/wired/dns_servers/'+str(_dns_server_index)+'/',auth=auth,headers=headers).json())

⇒

'37.202.173.236'

Browse more samples

Wireless network data, if any

sum (optional object)	network/wireless/
Data related to wireless network state and configuration, if any

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

This sum can assume the following values:

constant null	No wireless module	The wireless module is not installed
object	Wireless network data	Data related to wireless network state and configuration

Sample requests read command:

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

⇒

Sample JS request read command:

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

⇒

Browse more samples

Wireless network data

(possibly) object	network/wireless/
Data related to wireless network state and configuration

This object contains the following items:

Browse more samples

Wireless network data: Enable wireless module

sum (boolean)	network/wireless/enabled/
Flag indicating whether the wireless module is enabled

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

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

Sample JS request write command:

request.put({url:"network/wireless/enabled/",body:false});

Sample requests write command:

requests.put('http://192.168.0.100/restapi/network/wireless/enabled/',auth=auth,headers=headers,json=True)

Browse more samples

Wireless network data: Online

sum (boolean)	network/wireless/online/
Flag indicating the interface online status

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

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

This sum can assume the following values:

constant true	Online	The interface is online
constant false	Offline	The interface is offline

Sample requests read command:

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

⇒

False

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/wireless/online/"

⇒

false

Browse more samples

Wireless network data: MAC address

string	network/wireless/mac_address/
MAC address to use for this interface

The value is subject to the following constraints: the value matches ^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample CLI write command:

uom set "network/wireless/mac_address" "\"7C:E1:FF:93:1D:D5\""

Sample curl write command:

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"7C:E1:FF:92:02:82\"" "http://192.168.0.100/restapi/network/wireless/mac_address/"

Browse more samples

Wireless network data: IP address assignment protocol

string	network/wireless/protocol/
Method for obtaining an IP address for this interface

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample requests read command:

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

⇒

'static'

Sample JS request read command:

request.get({url:"network/wireless/protocol/"},function(error,response,body) {console.log(body)});

⇒

"dhcp"

Browse more samples

Wireless network data: IP address

string	network/wireless/ip_address/
IP address to use for this interface

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

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

Changes to this string do not take effect immediately.

Sample JS request read command:

request.get({url:"network/wireless/ip_address/"},function(error,response,body) {console.log(body)});

⇒

"10.206.30.62"

Sample CLI read command:

uom get "network/wireless/ip_address"

⇒

"192.168.96.157"

Browse more samples

Wireless network data: Network mask

string	network/wireless/netmask/
Network mask to use for this interface

The value is subject to the following constraints: the value matches ^((2(5[42]|4[80]|24)|192|128|0).0.0.0|255.(2(5[42]|4[80]|24)|192|128|0).0.0|255.255.(2(5[42]|4[80]|24)|192|128|0).0|255.255.255.(2(5[542]|4[80]|24)|192|128|0))$

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

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

Changes to this string do not take effect immediately.

Sample JS request read command:

request.get({url:"network/wireless/netmask/"},function(error,response,body) {console.log(body)});

⇒

"255.255.255.0"

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/wireless/netmask/"

⇒

"255.0.0.0"

Browse more samples

Wireless network data: Default gateway IP address, if any

sum (optional string)	network/wireless/gateway/
The IP address to send packets which are not targeted to local networks, if any

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

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

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

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant null	No default gateway	Packets with nonlocal destination are dropped
string	Default gateway IP address	The IP address to send packets which are not targeted to local networks	the value matches ^(([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5]).){3}([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])$

Sample CLI read command:

uom get "network/wireless/gateway"

⇒

null

Sample JS request read command:

request.get({url:"network/wireless/gateway/"},function(error,response,body) {console.log(body)});

⇒

"10.0.0.35"

Browse more samples

Wireless network data: Metric

number	network/wireless/metric/
Cost associated with sending packets over this interface

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

the value is an integer
the value is greater or equal to 0
the value is less or equal to 4294967295

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Changes to this number do not take effect immediately.

Sample requests read command:

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

⇒

{}

Sample requests write command:

requests.put('http://192.168.0.100/restapi/network/wireless/metric/',auth=auth,headers=headers,json={})

Browse more samples

Wireless network data: DNS servers

array	network/wireless/dns_servers/
List of DNS server IP addresses

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This array represents a value in persistent storage.

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

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

Changes to this array do not take effect immediately.

This array contains DNS server elements.

Sample uom library write command:

uom.network.wireless.dns_servers={"60.165.72.114"}

Sample CLI read command:

uom get "network/wireless/dns_servers"

⇒

["2.85.234.61"]

Browse more samples

DNS server

string	network/wireless/dns_servers/N/
DNS server IP address

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

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

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

request.put({url:"network/wireless/dns_servers/"+_dns_server_index.toString()+"/",body:"161.24.206.179"});

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

request.get({url:"network/wireless/dns_servers/"+_dns_server_index.toString()+"/"},function(error,response,body) {console.log(body)});

⇒

[]

Browse more samples

Wireless network data: DNS server

sum (boolean)	network/wireless/serve_dns/
Respond to DNS queries

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

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

Sample curl write command:

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "true" "http://192.168.0.100/restapi/network/wireless/serve_dns/"

Sample uom library read command:

print(uom.dump(uom.network.wireless.serve_dns))

⇒

true

Browse more samples

Wireless network data: Mode

string	network/wireless/mode/
Wireless module mode

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample uom library write command:

uom.network.wireless.mode="sta"

Sample JS request read command:

request.get({url:"network/wireless/mode/"},function(error,response,body) {console.log(body)});

⇒

"ap"

Browse more samples

Wireless network data: Known modes

map	network/wireless/known_modes/
Known wireless modes

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Mode elements.

Creating elements in this collection is not supported.

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/wireless/known_modes/"

⇒

{"sta":"Client","ap":"Access Point"}

Sample uom library read command:

print(uom.dump(uom.network.wireless.known_modes))

⇒

{ap="Access Point",sta="Client"}

Browse more samples

Mode

string	network/wireless/known_modes/S/
Name of wireless mode

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/wireless/known_modes/:mode/"

⇒

"Access Point"

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

request.get({url:"network/wireless/known_modes/"+_mode+"/"},function(error,response,body) {console.log(body)});

⇒

"Access Point"

Browse more samples

Wireless network data: SSID

string	network/wireless/ssid/
SSID (wireless network name) to use

The value is subject to the following constraints: length of the value is less or equal to 32

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample JS request read command:

request.get({url:"network/wireless/ssid/"},function(error,response,body) {console.log(body)});

⇒

"an4LJUezt"

Sample JS request write command:

request.put({url:"network/wireless/ssid/",body:"DLI_EPCR756"});

Browse more samples

Wireless network data: Wireless channel

string	network/wireless/channel/
Wireless channel to use

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample CLI write command:

uom set "network/wireless/channel" "\"auto\""

Sample uom library read command:

print(uom.dump(uom.network.wireless.channel))

⇒

"6"

Browse more samples

Wireless network data: Known channels

map	network/wireless/known_channels/
Known wireless channels

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Channel elements.

Creating elements in this collection is not supported.

Sample CLI read command:

uom get "network/wireless/known_channels"

⇒

{"1":"1 (2412 MHz)","auto":"Autoselect","2":"2 (2417 MHz)","5":"5 (2432 MHz)","4":"4 (2427 MHz)","7":"7 (2442 MHz)","6":"6 (2437 MHz)","9":"9 (2452 MHz)","8":"8 (2447 MHz)","3":"3 (2422 MHz)","11":"11 (2462 MHz)","10":"10 (2457 MHz)"}

Sample JS request read command:

request.get({url:"network/wireless/known_channels/"},function(error,response,body) {console.log(body)});

⇒

{"1":"1 (2412 MHz)","auto":"Autoselect","2":"2 (2417 MHz)","5":"5 (2432 MHz)","4":"4 (2427 MHz)","7":"7 (2442 MHz)","6":"6 (2437 MHz)","9":"9 (2452 MHz)","8":"8 (2447 MHz)","3":"3 (2422 MHz)","11":"11 (2462 MHz)","10":"10 (2457 MHz)"}

Browse more samples

Channel

string	network/wireless/known_channels/S/
Name of wireless channel

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

print(uom.dump(uom.network.wireless.known_channels[_channel]))

⇒

"1 (2412 MHz)"

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

request.get({url:"network/wireless/known_channels/"+_channel+"/"},function(error,response,body) {console.log(body)});

⇒

"1 (2412 MHz)"

Browse more samples

Wireless network data: Encryption

string	network/wireless/encryption/
Wireless encryption to use

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

Sample uom library write command:

uom.network.wireless.encryption="psk2"

Sample CLI read command:

uom get "network/wireless/encryption"

⇒

"psk2"

Browse more samples

Wireless network data: Known encryptions

map	network/wireless/known_encryptions/
Known wireless encryptions

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Encryption elements.

Creating elements in this collection is not supported.

Sample CLI read command:

uom get "network/wireless/known_encryptions"

⇒

{"psk2":"WPA2 PSK","psk-mixed":"WPA/WPA2 PSK mixed mode","psk":"WPA PSK","none":"None"}

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/wireless/known_encryptions/"

⇒

{"psk2":"WPA2 PSK","psk-mixed":"WPA/WPA2 PSK mixed mode","psk":"WPA PSK","none":"None"}

Browse more samples

Encryption

string	network/wireless/known_encryptions/S/
Name of wireless encryption

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

print(requests.get('http://192.168.0.100/restapi/network/wireless/known_encryptions/'+_encryption+'/',auth=auth,headers=headers).json())

⇒

'WPA PSK'

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

request.get({url:"network/wireless/known_encryptions/"+_encryption+"/"},function(error,response,body) {console.log(body)});

⇒

"WPA PSK"

Browse more samples

Wireless network data: Key

string	network/wireless/key/
Encryption key

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

all of the following is true:
- length of the value is greater or equal to 8
- length of the value is less or equal to 63
encryption is equal to none

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

not administrative user
hide WiFi key

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Changes to this string do not take effect immediately.

This string should be displayed in a secure manner.

Sample JS request write command:

request.put({url:"network/wireless/key/",body:"bi$Roq9neTP)@Uc&S@afm06o.9tY7N@v7CN*4hvuBK!X#"});

Sample CLI read command:

uom get "network/wireless/key"

⇒

"(,COt&/GyDRh3GuiqNiW6,2yjW#cDGRIOptIt(krIC^YeVGV&01A8F"

Browse more samples

Access points: Access point

object	network/wireless/scan/results: 1/N/
Status and configuration of a nearby access point

This object does not correspond to an actual resource.

This object contains the following items:

channel	Wireless channel
ssid	SSID
encryption	Encryption
signal	Signal level

Wireless channel

string	network/wireless/scan/results: 1/N/channel/
Wireless channel of the access point

The value is subject to the following constraints: [invalid reference ../../../../known_channels][the value]

This string does not correspond to an actual resource.

SSID

string	network/wireless/scan/results: 1/N/ssid/
SSID (wireless network name) of the access point

The value is subject to the following constraints: length of the value is less or equal to 32

This string does not correspond to an actual resource.

Encryption

string	network/wireless/scan/results: 1/N/encryption/
Wireless encryption used by the access point

The value is subject to the following constraints: [invalid reference ../../../../known_encryptions][the value]

This string does not correspond to an actual resource.

Signal level

number	network/wireless/scan/results: 1/N/signal/
Access point reception signal level, in dBm

This number does not correspond to an actual resource.

Wireless network data: Scan access points

call	network/wireless/scan/
Scan and report nearby access points

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

The call has no arguments (supply empty tuple).

The call returns the following results:

Access points: array of "object "Access point""

Sample uom library invocation:

print(uom.dump(uom.network.wireless.scan()))

⇒

{channel="7",encryption="psk2",signal=-43,ssid="N-Wsk"}

Sample JS request invocation:

request.post({url:"network/wireless/scan/",body:[]});

⇒

{"signal":-19,"encryption":"psk2","ssid":"4uFfb","channel":"6"}

Browse more samples

Access points

array	network/wireless/scan/results: 1/
List of access points

This array does not correspond to an actual resource.

This array contains Access point elements.

Wireless network data: Wireless Accessory Configuration supported

sum (boolean)	network/wireless/wac_supported/
Flag indicating device support for Wireless Accessory Configuration

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

This sum can assume the following values:

constant true	Supported	The device supports WAC
constant false	Not supported	The device does not support WAC

Sample JS request read command:

request.get({url:"network/wireless/wac_supported/"},function(error,response,body) {console.log(body)});

⇒

true

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/wireless/wac_supported/"

⇒

false

Browse more samples

Wireless network data: Wireless Accessory Configuration enabled

sum (boolean)	network/wireless/wac_enabled/
Flag indicating whether Wireless Accessory Configuration is currently active (any manual changes automatically disable it)

Retrieving the value is denied if not administrative user

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

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

Changes to this sum cannot be tracked.

This sum can assume the following values:

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

Sample JS request read command:

request.get({url:"network/wireless/wac_enabled/"},function(error,response,body) {console.log(body)});

⇒

false

Sample uom library read command:

print(uom.dump(uom.network.wireless.wac_enabled))

⇒

false

Browse more samples

Interface priority order

array	network/interface_order/
The order of preference in which interfaces will be used

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This array contains Interface order element elements.

Sample JS request interface order element creation command:

request.post({url:"network/interface_order/",body:[]});

Sample uom library read command:

print(uom.dump(uom.network.interface_order))

⇒

{"wireless"}

Browse more samples

Interface order element

sum (enumerated string)	network/interface_order/N/
Element of the interface preference order

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

This sum can assume the following values:

constant "wired"	Wired	Wired network interface
constant "wireless"	Wireless	Wireless network interface (if configured)

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

uom get "network/interface_order/${interface_order_element_index}"

⇒

"wired"

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

print(requests.get('http://192.168.0.100/restapi/network/interface_order/'+str(_interface_order_element_index)+'/',auth=auth,headers=headers).json())

⇒

'wireless'

Browse more samples

Same subnet restriction

sum (boolean)	network/same_subnet_only/
Reject incoming connections from networks other than local subnets

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

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

Sample requests read command:

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

⇒

True

Sample JS request write command:

request.put({url:"network/same_subnet_only/",body:false});

Browse more samples

Known protocols

map	network/known_protocols/
Known IP address assignment protocols

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 Protocol elements.

Creating elements in this collection is not supported.

Sample requests read command:

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

⇒

{'dhcp': 'Dynamic IP/DHCP', 'static': 'Static IP'}

Sample JS request read command:

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

⇒

{"dhcp":"Dynamic IP/DHCP","static":"Static IP"}

Browse more samples

Protocol

string	network/known_protocols/S/
Name of IP address assignment protocol

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

uom get "network/known_protocols/${protocol}"

⇒

"Dynamic IP/DHCP"

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/known_protocols/:protocol/"

⇒

"Static IP"

Browse more samples

Notifications

object	network/notifications/
Network interface status notifications

Retrieving the value is denied if not administrative user

This object does not support direct modification.

This object contains the following items:

parameter_kinds	Parameter kinds
events	Events

Sample curl read command:

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

⇒

Sample CLI read command:

uom get "network/notifications"

⇒

Browse more samples

Events

map	network/notifications/events/
Event templates

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Event elements.

Creating elements in this collection is not supported.

Sample JS request read command:

request.get({url:"network/notifications/events/"},function(error,response,body) {console.log(body)});

⇒

Sample requests read command:

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

⇒

Browse more samples

Notifications: Parameter kinds

object	network/notifications/parameter_kinds/
Kinds of event parameters

This object does not correspond to an actual resource.

This object contains the following items:

network_device	Device name
network_link_id	Device index
network_up	Status

Device name

string	network/notifications/parameter_kinds/network_device/
Low-level network interface name

Device index

number	network/notifications/parameter_kinds/network_link_id/
Low-level network interface index

The value is subject to the following constraints: the value is an integer

Status

sum (boolean)	network/notifications/parameter_kinds/network_up/
Network interface status

This sum can assume the following values:

constant true	Up	The network interface is connected
constant false	Down	The network interface is disconnected

Event parameters: Event parameter

object	network/notifications/events/S/parameters/N/
Properties of a parameter associated with the event

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

This object contains the following items:

id	Identifier
has_fixed_value	Fixed value flag
fixed_value	Fixed value

Sample curl write command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"fixed_value\":null,\"has_fixed_value\":false,\"id\":\"network_link_id\"}" "http://192.168.0.100/restapi/network/notifications/events/:event/parameters/:event_parameter_index/"

Sample uom library write command (note that _event and _event_parameter_index are variables):

uom.network.notifications.events[_event].parameters[_event_parameter_index]={fixed_value=null,has_fixed_value=false,id="network_link_id"}

Browse more samples

Identifier

string	network/notifications/events/S/parameters/N/id/
Parameter identifier

The value is subject to the following constraints: parameter kinds[the value]

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

Sample JS request read command (note that _event and _event_parameter_index are variables):

request.get({url:"network/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/id/"},function(error,response,body) {console.log(body)});

⇒

"network_up"

Sample CLI read command (note that event and event_parameter_index are variables):

uom get "network/notifications/events/${event}/parameters/${event_parameter_index}/id"

⇒

"network_device"

Browse more samples

Fixed value flag

sum (boolean)	network/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

This sum can assume the following values:

constant true	Fixed	The value is fixed
constant false	Variable	The value is variable

Sample uom library read command (note that _event and _event_parameter_index are variables):

print(uom.dump(uom.network.notifications.events[_event].parameters[_event_parameter_index].has_fixed_value))

⇒

false

Sample curl read command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/notifications/events/:event/parameters/:event_parameter_index/has_fixed_value/"

⇒

true

Browse more samples

Fixed value

sum (variant)	network/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

This sum can assume the following values:

constant null	Null	Null
constant true	True	True
constant false	False	False
string	String	This string
number	Number	This number

Sample curl read command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/notifications/events/:event/parameters/:event_parameter_index/fixed_value/"

⇒

null

Sample uom library read command (note that _event and _event_parameter_index are variables):

print(uom.dump(uom.network.notifications.events[_event].parameters[_event_parameter_index].fixed_value))

⇒

null

Browse more samples

Events: Event

object	network/notifications/events/S/
Event template

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

This object contains the following items:

message_template	Message template
severity	Severity
parameters	Event parameters

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

print(requests.get('http://192.168.0.100/restapi/network/notifications/events/'+_event+'/',auth=auth,headers=headers).json())

⇒

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

uom.network.notifications.events[_event]={message_template={"Interface \"",0,"\" is down"},parameters={{fixed_value=null,has_fixed_value=false,id="network_device"},{fixed_value=null,has_fixed_value=false,id="network_link_id"},{fixed_value=false,has_fixed_value=true,id="network_up"}},severity=5}

Browse more samples

Message template

array	network/notifications/events/S/message_template/
Template for human-readable message generation

Retrieving the value is denied if not administrative user

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

This array does not support direct modification.

This array contains Message template element elements.

Creating elements in this collection is not supported.

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

uom get "network/notifications/events/${event}/message_template"

⇒

["Interface \"",0,"\" is up"]

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

print(uom.dump(uom.network.notifications.events[_event].message_template))

⇒

{"Interface \"",0,"\" is down"}

Browse more samples

Message template element

sum (variant)	network/notifications/events/S/message_template/N/
Element of human-readable message template

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

This sum can assume the following values:

string	String	Fixed string
number	Parameter	Index of message parameter to insert	event parameters[the value]

Sample CLI read command (note that event and message_template_element_index are variables):

uom get "network/notifications/events/${event}/message_template/${message_template_element_index}"

⇒

"\" is up"

Sample requests read command (note that _event and _message_template_element_index are variables):

print(requests.get('http://192.168.0.100/restapi/network/notifications/events/'+_event+'/message_template/'+str(_message_template_element_index)+'/',auth=auth,headers=headers).json())

⇒

'" is down'

Browse more samples

Severity

sum (enumerated number)	network/notifications/events/S/severity/
Severity rating assigned to the event

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

This sum can assume the following values:

constant 1	Emergency	Treat the event as an emergency
constant 2	Alert	Treat the event as an alert
constant 3	Critical	Treat the event as critical
constant 4	Error	Treat the event as an error
constant 5	Warning	Treat the event as a warning
constant 6	Notice	Treat the event as a notice
constant 7	Informational	Treat the event as informational
constant 8	Debug	Treat the event as debugging-related

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

request.get({url:"network/notifications/events/"+_event+"/severity/"},function(error,response,body) {console.log(body)});

⇒

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

print(requests.get('http://192.168.0.100/restapi/network/notifications/events/'+_event+'/severity/',auth=auth,headers=headers).json())

⇒

Browse more samples

Event parameters

array	network/notifications/events/S/parameters/
Additional data associated with the event

Retrieving the value is denied if not administrative user

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

This array does not support direct modification.

This array contains Event parameter elements.

Creating elements in this collection is not supported.

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/network/notifications/events/:event/parameters/"

⇒

[{"fixed_value":null,"has_fixed_value":false,"id":"network_device"},{"fixed_value":null,"has_fixed_value":false,"id":"network_link_id"},{"fixed_value":false,"has_fixed_value":true,"id":"network_up"}]

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

print(requests.get('http://192.168.0.100/restapi/network/notifications/events/'+_event+'/parameters/',auth=auth,headers=headers).json())

⇒

[{'fixed_value': None, 'has_fixed_value': False, 'id': 'network_device'}, {'fixed_value': None, 'has_fixed_value': False, 'id': 'network_link_id'}, {'fixed_value': True, 'has_fixed_value': True, 'id': 'network_up'}]

Browse more samples

enabled	Enable wireless module
online	Online
mac_address	MAC address
protocol	IP address assignment protocol
ip_address	IP address
netmask	Network mask
gateway	Default gateway IP address, if any
metric	Metric
dns_servers	DNS servers
serve_dns	DNS server
mode	Mode
known_modes	Known modes
ssid	SSID
channel	Wireless channel
known_channels	Known channels
encryption	Encryption
known_encryptions	Known encryptions
key	Key
scan	Scan access points
wac_supported	Wireless Accessory Configuration supported
wac_enabled	Wireless Accessory Configuration enabled