Skip to content

Edge commands

Use an Edge's Commands tab to send commands to the Edge from the portal and follow every command sent to it.

Operators who use the Privitty App send a different set of commands to devices behind an Edge. See Device commands.

Commands you can send

Command Where Who What the Edge does Expires after
Rebirth Commands tab Operator, Admin, Owner Reports its full asset list and configuration version again. 5 minutes
Collect diagnostics Commands tab Owner Builds a diagnostics bundle for Privitty support, with passwords, tokens and keys removed. 15 minutes
Rediscover Asset page Operator, Admin, Owner Browses the asset's device for tags. See Assets, tags and live values. 1 hour
Restart connector Asset page Operator, Admin, Owner Reconnects to this one asset. The rest of the Edge keeps running. 1 hour

The Edge accepts a command only if its Overview tab lists the matching capability, such as cmd.rebirth or cmd.collect_diagnostics. Otherwise you see device does not advertise <capability>. Commands to a deactivated Edge fail with device is deactivated.

When to use each

  • Rebirth: the Edge's Assets tab is empty or out of date.
  • Collect diagnostics: Privitty support asks for a bundle.
  • Rediscover: you added an asset or changed the device's program and want to browse its tags.
  • Restart connector: one asset stays disconnected after you fixed the network or the device. A restart does not fix a configuration error.

Send a command

  1. Open Edges, open the Edge and choose the Commands tab.
  2. Click Rebirth or Collect diagnostics. The button shows Queuing… while the portal sends it.
  3. A new row appears in the list. Follow its State.

You can send a command while the Edge is offline. It waits as queued until the Edge reconnects or the command expires.

Read the results

The list shows every command for this Edge with Kind, State, Created and Error.

State Meaning What to do
queued Waiting for the Edge to be online. Wait, or cancel.
sent Delivered, waiting for the Edge to acknowledge. Wait.
accepted The Edge is running it. Wait.
done Finished. Nothing.
failed The Edge tried and failed. Read Error.
rejected The Edge refused it, for example because it expired or is not supported. Read Error. Send it again if needed.
expired The time ran out before the Edge finished it. Send it again when the Edge is online.
cancelled A user cancelled it. Nothing.

To cancel a command that is queued, sent or accepted, click Cancel on its row. Operators, Admins and Owners can cancel.

Download a diagnostics bundle

  1. Click Collect diagnostics.
  2. Wait until the collect_diagnostics row shows done.
  3. Click Download on that row.

The download works for about 15 minutes after you request the bundle. Send the file to Privitty support through the channel listed in your Privitty agreement.

Commands Watchtower sends

These rows also appear in the list. You do not send them from this tab.

Kind Sent when
update_agent An agent update reaches the Edge. See Updates.
provision_relay The Edge is added to Watchtower.
join, delete An operator's access to the Edge starts or ends. See Grant access to an Edge.