DLI DC3 Object Model Reference
20210819T152642Z
Network configuration data
objectnetwork/
Data related to network state and configuration
dot_inline_dotgraph_348.png

Retrieving the value is denied if not administrative user

This object contains the following items:

wiredWired network data
wirelessWireless network data, if any
interface_orderInterface priority order
same_subnet_onlySame subnet restriction
known_protocolsKnown protocols
notificationsNotifications

Sample uom library write command:

uom.network=<...>

Sample curl read command:

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

...

Browse more samples

Wired network data

objectnetwork/wired/
Data related to wired network state and configuration
dot_inline_dotgraph_349.png

Retrieving the value is denied if not administrative user

This object contains the following items:

mac_addressMAC address
onlineOnline
protocolIP address assignment protocol
ip_addressIP address
netmaskNetwork mask
gatewayDefault gateway IP address, if any
metricMetric
dns_serversDNS servers
serve_dnsDNS server

Sample JS request read command:

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

{"ip_address":"192.168.40.137","serve_dns":false,"protocol":"static","online":false,"gateway":"192.168.40.24","dns_servers":[],"mac_address":"7C:E1:FF:1E:05:6D","netmask":"255.255.255.0"}

Sample curl read command:

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

{"ip_address":"10.220.242.216","serve_dns":false,"protocol":"static","online":true,"gateway":"10.0.0.10","dns_servers":["153.175.156.30"],"mac_address":"7C:E1:FF:CA:7E:C0","netmask":"255.0.0.0"}

Browse more samples

MAC address

stringnetwork/wired/mac_address/
MAC address to use for this interface
dot_inline_dotgraph_350.png

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:CB:7E:8E"

Sample requests read command:

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

'7C:E1:FF:1E:7E:86'

Browse more samples

Online

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

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

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

This sum can assume the following values:

constant trueOnlineThe interface is online
constant falseOfflineThe interface is offline

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/network/wired/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/wired/online/"

false

Browse more samples

IP address assignment protocol

stringnetwork/wired/protocol/
Method for obtaining an IP address for this interface
dot_inline_dotgraph_352.png

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

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

"static"

Sample uom library write command:

uom.network.wired.protocol="dhcp"

Browse more samples

IP address

stringnetwork/wired/ip_address/
IP address to use for this interface
dot_inline_dotgraph_353.png

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

Retrieving the value is denied if not administrative user

Changing the value is denied if 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 write command:

request.put({url:"network/wired/ip_address/",body:"10.193.222.74"});

Sample JS request read command:

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

"10.76.48.70"

Browse more samples

Network mask

stringnetwork/wired/netmask/
Network mask to use for this interface
dot_inline_dotgraph_354.png

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

request.put({url:"network/wired/netmask/",body:"255.0.0.0"});

Sample CLI read command:

uom get "network/wired/netmask"

"255.255.255.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
dot_inline_dotgraph_355.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can 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 nullNo default gatewayPackets with nonlocal destination are dropped
stringDefault gateway IP addressThe IP address to send packets which are not targeted to local networksthe value matches ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

Sample curl read command:

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

null

Sample JS request read command:

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

null

Browse more samples

Metric

numbernetwork/wired/metric/
Cost associated with sending packets over this interface
dot_inline_dotgraph_356.png

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Changes to this number 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 "[]" "http://192.168.0.100/restapi/network/wired/metric/"

Sample uom library read command:

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

{}

Browse more samples

See also Wired network data: DNS servers

DNS server

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample requests read command:

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

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/network/wired/serve_dns/"

Browse more samples

Wired network data: DNS servers

arraynetwork/wired/dns_servers/
List of DNS server IP addresses
dot_inline_dotgraph_358.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This array represents a value in persistent storage.

This array 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 curl DNS server creation command:

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"141.234.131.202\"" "http://192.168.0.100/restapi/network/wired/dns_servers/"

Sample CLI write command:

uom set "network/wired/dns_servers" "[\"192.168.56.8\"]"

Browse more samples

DNS server

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

[]

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

'192.168.159.43'

Browse more samples

Wireless network data, if any

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

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

This sum can assume the following values:

constant nullNo wireless moduleThe wireless module is not installed
objectWireless network dataData related to wireless network state and configuration

Sample CLI read command:

uom get "network/wireless"

Sample JS request read command:

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

Browse more samples

Wireless network data

(possibly) objectnetwork/wireless/
Data related to wireless network state and configuration
dot_inline_dotgraph_360.png

This object contains the following items:

enabledEnable wireless module
onlineOnline
mac_addressMAC address
protocolIP address assignment protocol
ip_addressIP address
netmaskNetwork mask
gatewayDefault gateway IP address, if any
metricMetric
dns_serversDNS servers
serve_dnsDNS server
modeMode
known_modesKnown modes
ssidSSID
channelWireless channel
known_channelsKnown channels
encryptionEncryption
known_encryptionsKnown encryptions
keyKey
scanScan access points
wac_supportedWireless Accessory Configuration supported
wac_enabledWireless Accessory Configuration enabled

Browse more samples

See also Wireless network data: Enable wireless module

See also Wireless network data: Online

See also Wireless network data: MAC address

See also Wireless network data: IP address assignment protocol

See also Wireless network data: IP address

See also Wireless network data: Network mask

See also Wireless network data: Default gateway IP address, if any

See also Wireless network data: Metric

See also Wireless network data: DNS servers

See also Wireless network data: DNS server

See also Wireless network data: Mode

See also Wireless network data: Known modes

See also Wireless network data: SSID

See also Wireless network data: Wireless channel

See also Wireless network data: Known channels

See also Wireless network data: Encryption

See also Wireless network data: Known encryptions

See also Wireless network data: Key

See also Wireless network data: Scan access points

See also Wireless network data: Wireless Accessory Configuration supported

See also Wireless network data: Wireless Accessory Configuration enabled

Wireless network data: Enable wireless module

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample uom library read command:

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

true

Sample curl read command:

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

false

Browse more samples

Wireless network data: Online

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

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

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

This sum can assume the following values:

constant trueOnlineThe interface is online
constant falseOfflineThe interface is offline

Sample uom library read command:

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

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

stringnetwork/wireless/mac_address/
MAC address to use for this interface
dot_inline_dotgraph_363.png

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

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

"7C:E1:FF:55:D6:B1"

Sample curl read command:

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

"7C:E1:FF:59:46:4F"

Browse more samples

Wireless network data: IP address assignment protocol

stringnetwork/wireless/protocol/
Method for obtaining an IP address for this interface
dot_inline_dotgraph_364.png

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/wireless/protocol" "\"dhcp\""

Sample uom library write command:

uom.network.wireless.protocol="static"

Browse more samples

Wireless network data: IP address

stringnetwork/wireless/ip_address/
IP address to use for this interface
dot_inline_dotgraph_365.png

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

Retrieving the value is denied if not administrative user

Changing the value is denied if 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/wireless/ip_address/"

"10.235.122.60"

Sample JS request write command:

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

Browse more samples

Wireless network data: Network mask

stringnetwork/wireless/netmask/
Network mask to use for this interface
dot_inline_dotgraph_366.png

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

request.put({url:"network/wireless/netmask/",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
dot_inline_dotgraph_367.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can 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 nullNo default gatewayPackets with nonlocal destination are dropped
stringDefault gateway IP addressThe IP address to send packets which are not targeted to local networksthe 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"

"192.168.17.25"

Sample CLI write command:

uom set "network/wireless/gateway" "\"192.168.211.25\""

Browse more samples

Wireless network data: Metric

numbernetwork/wireless/metric/
Cost associated with sending packets over this interface
dot_inline_dotgraph_368.png

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Changes to this number do not take effect immediately.

Sample curl read command:

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

[]

Sample requests read command:

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

{}

Browse more samples

Wireless network data: DNS servers

arraynetwork/wireless/dns_servers/
List of DNS server IP addresses
dot_inline_dotgraph_369.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This array represents a value in persistent storage.

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

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

["56.44.233.122"]

Sample CLI read command:

uom get "network/wireless/dns_servers"

["202.66.201.142","147.147.19.218"]

Browse more samples

DNS server

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

uom set "network/wireless/dns_servers/${dns_server_index}" "[]"

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/wireless/dns_servers/:dns_server_index/"

"10.0.0.17"

Browse more samples

Wireless network data: DNS server

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample JS request read command:

request.get({url:"network/wireless/serve_dns/"},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/network/wireless/serve_dns/"

false

Browse more samples

Wireless network data: Mode

stringnetwork/wireless/mode/
Wireless module mode
dot_inline_dotgraph_371.png

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

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

"sta"

Sample JS request write command:

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

Browse more samples

Wireless network data: Known modes

mapnetwork/wireless/known_modes/
Known wireless modes
dot_inline_dotgraph_372.png

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Mode elements.

Creating elements in this collection is not supported.

Sample requests read command:

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

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

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

Browse more samples

Mode

stringnetwork/wireless/known_modes/S/
Name of wireless mode
dot_inline_dotgraph_373.png

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

uom get "network/wireless/known_modes/${mode}"

"Client"

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

stringnetwork/wireless/ssid/
SSID (wireless network name) to use
dot_inline_dotgraph_374.png

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

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

'DLI_DC356'

Sample curl read command:

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

"DLI_DC356"

Browse more samples

Wireless network data: Wireless channel

stringnetwork/wireless/channel/
Wireless channel to use
dot_inline_dotgraph_375.png

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

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

Sample requests write command:

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

Browse more samples

Wireless network data: Known channels

mapnetwork/wireless/known_channels/
Known wireless channels
dot_inline_dotgraph_376.png

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Channel elements.

Creating elements in this collection is not supported.

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

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

Browse more samples

Channel

stringnetwork/wireless/known_channels/S/
Name of wireless channel
dot_inline_dotgraph_377.png

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

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

"7 (2442 MHz)"

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

uom get "network/wireless/known_channels/${channel}"

"1 (2412 MHz)"

Browse more samples

Wireless network data: Encryption

stringnetwork/wireless/encryption/
Wireless encryption to use
dot_inline_dotgraph_378.png

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

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

'psk-mixed'

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 "\"none\"" "http://192.168.0.100/restapi/network/wireless/encryption/"

Browse more samples

Wireless network data: Known encryptions

mapnetwork/wireless/known_encryptions/
Known wireless encryptions
dot_inline_dotgraph_379.png

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Encryption elements.

Creating elements in this collection is not supported.

Sample uom library read command:

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

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

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

stringnetwork/wireless/known_encryptions/S/
Name of wireless encryption
dot_inline_dotgraph_380.png

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

uom get "network/wireless/known_encryptions/${encryption}"

"WPA/WPA2 PSK mixed mode"

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

stringnetwork/wireless/key/
Encryption key
dot_inline_dotgraph_381.png

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

  • all of the following is true:
  • encryption is equal to none

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

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 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 "\"o0#V@eUvIlv^NOLx^9wEm7,veb4T6)y\"" "http://192.168.0.100/restapi/network/wireless/key/"

Sample curl read command:

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

"V2/^sI@yKdd9(wK-*JkVuEkuV6$"

Browse more samples

Access points: Access point

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

channelWireless channel
ssidSSID
encryptionEncryption
signalSignal level

Wireless channel

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

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

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

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

callnetwork/wireless/scan/
Scan and report nearby access points
dot_inline_dotgraph_382.png

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

The call has no arguments (supply empty tuple).

The call returns the following results:

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

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/network/wireless/scan/"

{"signal":-28,"encryption":"psk","ssid":"3nDh","channel":"2"}

Sample requests invocation:

print(requests.post('http://192.168.0.100/restapi/network/wireless/scan/',auth=auth,headers=headers,json={}).json())

{'signal': -74, 'encryption': 'none', 'ssid': 'RybdTCt', 'channel': '10'}

Browse more samples

Access points

arraynetwork/wireless/scan/results: 1/
List of access points
dot_inline_dotgraph_383.png

This array does not correspond to an actual resource.

This array contains Access point elements.

See also Access points: Access point

Wireless network data: Wireless Accessory Configuration supported

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

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

This sum can assume the following values:

constant trueSupportedThe device supports WAC
constant falseNot supportedThe device does not support WAC

Sample uom library read command:

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

false

Sample CLI read command:

uom get "network/wireless/wac_supported"

true

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)
dot_inline_dotgraph_385.png

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

Sample curl read command:

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

false

Sample requests read command:

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

False

Browse more samples

Interface priority order

arraynetwork/interface_order/
The order of preference in which interfaces will be used
dot_inline_dotgraph_386.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This array contains Interface order element elements.

Sample CLI interface order element creation command:

uom insert "network/interface_order/1" "\"wireless\""

Sample CLI read command:

uom get "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"WiredWired network interface
constant "wireless"WirelessWireless network interface (if configured)

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

request.delete({url:"network/interface_order/"+_interface_order_element_index.toString()+"/"});

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

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

Browse more samples

Same subnet restriction

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

Changes to this sum do not take effect immediately.

This sum can assume the following values:

constant trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample curl write command:

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

Sample requests read command:

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

False

Browse more samples

Known protocols

mapnetwork/known_protocols/
Known IP address assignment protocols
dot_inline_dotgraph_388.png

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Protocol 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/known_protocols/"

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

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

Browse more samples

Protocol

stringnetwork/known_protocols/S/
Name of IP address assignment protocol
dot_inline_dotgraph_389.png

Retrieving the value is denied if not administrative user

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

This string does not support direct modification.

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

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

"Dynamic IP/DHCP"

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

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

"Dynamic IP/DHCP"

Browse more samples

Notifications

objectnetwork/notifications/
Network interface status notifications
dot_inline_dotgraph_390.png

Retrieving the value is denied if not administrative user

This object does not support direct modification.

This object contains the following items:

parameter_kindsParameter kinds
eventsEvents

Sample uom library read command:

print(uom.dump(uom.network.notifications))

Sample JS request read command:

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

Browse more samples

See also Notifications: Parameter kinds

Events

mapnetwork/notifications/events/
Event templates
dot_inline_dotgraph_391.png

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Event elements.

Creating elements in this collection is not supported.

Sample requests read command:

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

Sample uom library read command:

print(uom.dump(uom.network.notifications.events))

Browse more samples

See also Events: Event

Notifications: Parameter kinds

objectnetwork/notifications/parameter_kinds/
Kinds of event parameters

This object does not correspond to an actual resource.

This object contains the following items:

network_deviceDevice name
network_link_idDevice index
network_upStatus

Device name

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

Device index

numbernetwork/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 trueUpThe network interface is connected
constant falseDownThe network interface is disconnected

Event parameters: Event parameter

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

idIdentifier
has_fixed_valueFixed value flag
fixed_valueFixed value

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

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

{'fixed_value': None, 'has_fixed_value': False, 'id': 'network_device'}

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

uom set "network/notifications/events/${event}/parameters/${event_parameter_index}" "{\"fixed_value\":false,\"has_fixed_value\":true,\"id\":\"network_up\"}"

Browse more samples

Identifier

stringnetwork/notifications/events/S/parameters/N/id/
Parameter identifier
dot_inline_dotgraph_392.png

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

"network_device"

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"

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
dot_inline_dotgraph_393.png

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

This sum can assume the following values:

constant trueFixedThe value is fixed
constant falseVariableThe value is variable

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

false

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

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

False

Browse more samples

Fixed value

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

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

This sum can assume the following values:

constant nullNullNull
constant trueTrueTrue
constant falseFalseFalse
stringStringThis string
numberNumberThis 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

objectnetwork/notifications/events/S/
Event template
dot_inline_dotgraph_395.png

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

This object contains the following items:

message_templateMessage template
severitySeverity
parametersEvent parameters

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

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

arraynetwork/notifications/events/S/message_template/
Template for human-readable message generation
dot_inline_dotgraph_396.png

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

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

['Interface "', 0, '" is down']

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

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

Browse more samples

Message template element

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

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

This sum can assume the following values:

stringStringFixed string
numberParameterIndex of message parameter to insertevent parameters[the value]

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

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

"Interface \""

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

0

Browse more samples

Severity

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

Retrieving the value is denied if not administrative user

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

This sum does not support direct modification.

This sum can assume the following values:

constant 1EmergencyTreat the event as an emergency
constant 2AlertTreat the event as an alert
constant 3CriticalTreat the event as critical
constant 4ErrorTreat the event as an error
constant 5WarningTreat the event as a warning
constant 6NoticeTreat the event as a notice
constant 7InformationalTreat the event as informational
constant 8DebugTreat the event as debugging-related

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

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

5

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

6

Browse more samples

Event parameters

arraynetwork/notifications/events/S/parameters/
Additional data associated with the event
dot_inline_dotgraph_399.png

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 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': False, 'has_fixed_value': True, 'id': 'network_up'}]

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

Browse more samples

See also Event parameters: Event parameter