Cirrus Link Website
Contact Us (Sales/Support)
Forum
Cirrus Link Modules Docs for Ignition 8.1.x
Cirrus Link Modules Docs for Ignition 7.9.x
Ignition User Manual
Knowledge Base Articles
Inductive University
Forum
...
| Warning |
|---|
Configuration changes made through scripting do have the same validation as when made through the UI. For example, attempting to delete a Sets configuring that is being referenced by a Servers configuration will result in no action being performed. |
...
...
| enabled | boolean | Whether or not the configuration resource is enabled |
| name | string | The unique name for the configuration resource |
| protocol | string | The IoT Hub client protocol |
| serverSet | string | The Set this IoT Hub connection is associated with |
| certAuthEnabled | boolean | Enable certificate based authentication instead of using a connection string |
| connectionString | string | The Azure Connection String used for establishing a connection with the IoT Hub |
| mqttHostname | string | The hostname of the Azure IoT Hub endpoint |
| deviceId | string | The Device ID as provisioned in the Azure IoT Hub configuration |
| caCertFile | string | CA Certificate file currently in use |
| clientCertFile | string | Client certificate file currently in use |
| clientPrivateKeyFile | string | Client private key file currently in use |
| clientKeyPassword | string | The password associated with the certificate's private key (optional) |
| historyEnabled | boolean | Enable Store and Forward capabilities for this stream |
| historyStoreType | string | The Type of this Store & Forward mechanism |
| partionPeriod | string | The partitioning scheme to use for the Disk-backed history store (e.g. HOUR, MINUTE, DAY, etc) |
| historyMaxSize | integer | Maximum number of megabytes history can use before dropping the data |
| trimmerTaskPeriodMultiplier | integer | A integer multiplier which is applied to the 'storageMonitorPeriod' which results in the period in which to trim potential excess history |
| historyMaxAge | integer | Maximum number of minutes to store history before dropping the data |
| queryTimeout | integer | The H2 DB query timeout in seconds for the disk-backed history store |
| flushPeriod | long | Upon reestablishing communication, the period to wait in milliseconds between sending when flushing messages |
| keepAlive | integer | The MQTT Client keep alive time (in seconds) |
| maxSize | integer | Maximum message size before dividing into multiple messages |
| expiration | long | The number of seconds before the session token expires |
| contentType | string | The content type to include in the topic to Azure IoT Hub |
| contentEncoding | string | The content encoding to include in the topic to Azure IoT Hub |
| azureDateTimeFormat | string | The date/time format to use when pushing data to Azure |
| customTopicExtension | string | The Custom Topic Extension to append to the topic string for things like Application Properties |
| h2dbDirectory | string | Directory to store the H2 Database in. Applicable for Disk-backed history store only |
| h2dbPort | integer | TCP Port to connect to H2 Database. Applicable for Disk-backed history store only |
| dbMaxMessageSize | integer | The Max Message size allowed in the Store and Forward DB. This only applies to Disk-Backed history stores |
| republishBirths | boolean | Whether or not to republish BIRTH messages on re |
| enabled | boolean | Whether or not the configuration resource is enabled |
| name | string | The unique name for the configuration resource |
| fileName | string | The name of this certificate file or private key |
| description | string | The description of this certificate file or private key |
| fileContents | string | The contents of this certificate file or private key |
| enabled | boolean | Whether or not the configuration resource is enabled |
| name | string | The unique name for the configuration resource |
| description | string | Description of this Set |
| pushPolicy | string | The Push Policy defines whether all cloud end-points in a set will be pushed to or only one will at a time - PUSH_TO_ALL or PUSH_TO_ANY |
| enabled | boolean | Whether or not the configuration resource is enabled |
| name | string | The unique name for the configuration resource |
| tagProvider | string | The Name of the tag provider |
| tagPath | string | A path to the root folder where the tag tree starts (optional) |
| pushTrigger | string | The trigger to use when pushing data - EVENT_DRIVEN, PERIODIC or HYBRID |
| tagPacingPeriod | long | If using an EVENT_DRIVEN Push trigger, the waiting period in milliseconds after an initial tag change event before pushing all changed tags. If using PERIODIC, the number of milliseconds to wait between pushing all data |
| convertUdts | boolean | Converts UDT members to normal Tags |
| sendAllProps | boolean | Send all properties, including non-default properties, in Sparkplug BIRTH messages |
| includeQualityContext | boolean | Include the metric 'quality context' string in addition to the quality codes for metrics |
| includeInfoFolders | boolean | Push all Node and Device Info and Control folder information (from MQTT Engine) rather than excluding it |
| publishUdtDefinitions | boolean | Publish UDT Definitions in BIRTH |
| optimizeUdts | boolean | Optimizes UDT payload sizes in NDATA and DDATA payloads |
| serverSet | string | The Set this Agent is associated with |
| groupId | string | An ID representing a logical grouping of Edge Nodes and Devices (optional) |
| edgeNodeId | string | An ID representing an Edge or Network (EoN) Node (optional) |
| deviceId | string | An ID representing a Device (optional) |
| filteredProperties | string | A semicolon delimited list of Tag properties to filter/block from being published |
| birthSettleDelay | long | The amount of time to wait after setting the BIRTH timestamp before fetching the cached BIRTH payloads |
