claim

The claim command is a security feature that prevents rogue API servers, for example one running on a laptop plugged into an installation's network port, from taking control of an SDVoE system. Once a device is claimed, it can only be controlled or discovered by API server instances that share the claim key of the server that claimed it.

The release command returns devices to the unclaimed state.


Command Type	SDVoE
Minimum Version	3.x.x

Requires the Admin role

Usage

claim <target>

Arguments

Argument	Required	Description
`target`	Yes	Device name, MAC address, or device ID of a single device, or a device group. See Targets.

Targets

Value	Claims
`<device>`	A single device
`ALL`	All devices
`ALL_TX`	All transmitter devices
`ALL_RX`	All receiver devices

Changing the claim key

The server's claim key is the device_claim_key value, set via the config command.

Examples

Claim a single device
claim room_projector

Claim every device in the system
claim ALL

Return value

claim is processed asynchronously. The immediate reply is PROCESSING with a request_id. Read the outcome with request.

claim room_projector
{
  "status": "PROCESSING",
  "request_id": 42,
  "result": null,
  "error": null
}

Notifications

Claiming devices raises NOTIFICATION messages carrying the devices' updated state. See Notifications.

REST API

Although claim originates in the SDVoE API, the REST example below uses a DisplayNet API operation. Use the endpoint shown here. DisplayNet uses it to maintain its own device records.

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`

Operation	Parameters
`claim`	`device` `[args]*`

A parameter in brackets is optional. A parameter marked * takes the remainder of the command line as one string. Pass the text exactly as you would type it on the TCI interface.

Usage​

Arguments​

Targets​

Examples​

Return value​

Notifications​

REST API​

See also​