Provision Action Properties

Owned by Sacha Parisot (Unlicensed)
03-Jun-2022
1 min read


The provision action supports the following arguments, submitted with the args parameter (described in the Properties table for Device Do Action):

Argument

Type

Description

grouping

Number

(Optional) The CMS can provide a numerical identifier for the group of devices this device belongs to. The edge server can take advantage from this information in the assignment of the device’s logical address, avoiding possible need to reconfigure that address later.

The group indicated here does not need to correspond to a group in the GLP, but more typically corresponds to a physical grouping of devices, for example by location.

When a device is registered with the CMS, the CMS can be informed of the device’s logical grouping, for example through the device’s physical location. Those co-located devices can sometimes benefit from special edge protocol addressing modes, for example to facilitate near-simultaneous switching or point-to-point connections, and some edge servers can take advantage from such guidance from the start.

The device-grouping capability indicates whether the edge server is using this feature. See the About topic for a description of the capabilities property.

unid

string

(Optional) unid is the device’s protocol-specific unique identifier, and has the following usage rules:

  • The unique ID provided with add must not already be in use.
  • The unique ID provided with replace must not be in use or refer to a device in the unprovisioned state.
  • When a unid is omitted from create it must be supplied with provision.
  • When devices are created with provision: true, the unid must be supplied at the same time.
  • When unid is provided with both create and provision the values must be the same.

Example: "0503C0123451"