replace

The replace command replaces a device in DisplayNet: it copies the attributes and configurations of a disconnected device onto a connected device. This allows rapid replacement of failed devices without reprogramming connected control systems.

Device replacement supports multiviews, walls, presets, configs, scripts, and EDIDs.


Command Type	DisplayNet
Minimum Version	2.x.x

Requires the Admin role

Usage

replace <entity>[,<entity>...] <source> <target>
replace getknown
replace removeknown <source>
replace removeallknown
replace refreshknown

Replacing a device

replace <entitylist> <source> <target> migrates the listed entities from a disconnected device to an online one.

Argument	Required	Description
`entitylist`	Yes	Comma-separated list of the sections in which to replace the device. See Entities.
`source`	Yes	MAC address of the disconnected device being replaced.
`target`	Yes	An online device of the same type as the source (TX/RX), by MAC address or device name.

Entities

Entity	Replaces the device in
`walls`	Wall configurations
`multiviews`	MultiView configurations
`presets`	Snapshot-type presets
`configs`	`config` settings
`scripts`	Script-type presets
`name`	The hostname of the device
`edid`	The stored EDID on the device
`all`	All of the above

Managing the known device list

Replacement sources come from the known device list, which holds devices the server has previously seen, online or offline.

Subcommand	Description
`getknown`	Retrieves the list of known devices (online and offline)
`removeknown`	Removes a disconnected device from the known device list. Only offline devices can be removed
`removeallknown`	Removes all devices from the known device list. Send `refreshknown` afterwards
`refreshknown`	Forces a refresh of the known device list

Examples

Replace a failed TX in walls and multiviews, keeping its hostname
replace walls,multiviews,name 341b22f00185 d88039a5a2ea

Replace a device everywhere
replace all 341b22f00185 Sony_Monitor

Remove a retired device from the known list
replace removeknown 341b11f00385

Return value

Replacing a device returns a basic SUCCESS or ERROR envelope. The known-device subcommands return the known device list:

replace getknown
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "knowndevices": [
      {
        "DeviceId": "341b22f00185",
        "DeviceName": "Transmitter_1",
        "IsTransmitter": true,
        "IsReceiver": false,
        "EDID": "<EDIDHEXVALUE>"
      },
      {
        "DeviceId": "d88039a5a2ea",
        "DeviceName": "Sony_Monitor",
        "IsTransmitter": false,
        "IsReceiver": true,
        "EDID": "<EDIDHEXVALUE>"
      }
    ]
  },
  "error": null
}

REST API

Endpoint type	DisplayNet API command
Address	`POST /api/displaynet/<operation>`, or name the operation in the body of a `POST /api/displaynet`. See Sending commands.
Role	`Admin`

Subcommand	Operation	Parameters
—	`replace`	`device_types` `source` `target`
`getknown`	`replace_getknown`	—
`refreshknown`	`replace_refreshknown`	—
`removeallknown`	`replace_removeallknown`	—
`removeknown`	`replace_removeknown`	`device`

Usage​

Replacing a device​

Entities​

Managing the known device list​

Examples​

Return value​

REST API​

See also​