ip

set ip configures the IP settings of the primary network interface of a device, the SDVoE chipset, and, when applicable, the USB 2.0 chipset network interface.

Command Type	SDVoE
Minimum Version	3.x.x

Usage

set <target> ip mode dhcp
set <target> ip mode auto_ip
set <target> ip mode manual address <address> [icron_address <address>] mask <mask> gateway <gateway>

Arguments

Argument	Required	Description
target	Yes	Hostname or MAC address of a single device.
mode	Yes	The IP configuration mode. See Modes.
address	manual only	IP address for the SDVoE chipset.
icron_address	No	IP address for the USB 2.0 chipset. See USB 2.0 address.
mask	manual only	Subnet mask, in common format, e.g. 255.255.255.0.
gateway	manual only	IP address of the default network gateway.

Modes

Mode	Behavior
dhcp	Use DHCP. If no DHCP server is present, an address is self-assigned via APIPA
auto_ip	Always self-assign an address via APIPA, whether a DHCP server is present or not. Available on devices whose engine is PLETHORA; not available on the legacy BLUERIVER_NT chipset, and never applied to an attached USB 2.0 chipset
manual	Configure the address, mask, and gateway explicitly

USB 2.0 address

icron_address can only be given together with address. Specifying it alone returns an error. If the device's USB extender node (legacy: Icron USB Extender) reports chip_present as false, the icron_address is ignored.

Examples

Switch a device to DHCP
set 001ec0f03668 ip mode dhcp

Assign static addresses to the SDVoE and USB 2.0 chipsets
set 001ec0f03668 ip mode manual address 10.1.1.5 icron_address 10.1.1.6 mask 255.255.255.0 gateway 10.1.1.1

Return value

set 001ec0f03668 ip mode dhcp
{
  "status": "PROCESSING",
  "request_id": 57,
  "result": null,
  "error": null
}

Errors

Error	Cause
ILLEGAL_ARGUMENT	The target is not a valid device ID or group name

Notifications

set 001ec0f03668 ip mode dhcp
{
  "status": "NOTIFICATION",
  "request_id": null,
  "result": {
    "events": [
      {
        "device_id": "001ec0f03668",
        "event_id": 178,
        "event_type": "SETTINGS_CHANGED",
        "timestamp": 1460660784,
        "request_id": 178
      }
    ]
  },
  "error": null
}

REST API

Endpoint type	SDVoE API command, forwarded to the Control Server
Address	/api/device/{target}
Role	Governed by the device lock rather than by a DisplayNet role

POST /api/device/{target}

{
  "op": "set:ip:dhcp"
}

POST /api/device/{target}

{
  "op": "set:ip:auto_ip"
}

POST /api/device/{target}

{
  "op": "set:ip:static",
  "address": "String",
  "mask": "String",
  "gateway": "String"
}

Values labeled with a type name such as String or Integer are placeholders, not literal text. Replace them with actual values; fields marked (optional) can be omitted.

{target} takes a DisplayNet device name as readily as a device ID, and a locked device refuses a mutating operation. See SDVoE API operations for what DisplayNet adds to these calls.

See also

• get: read the current network settings
• query: the network subcommand, for a cheap live read