[space] Litmus Documentation [title] Litmus Documentation [path] / # Litmus Documentation You have reached the documentation index. Pick a documentation set below to get where you were headed. ## Platform - [Litmus Edge](https://docs.litmus.io/litmusedge) - current 4.0.x. Earlier versions: [3.16.x](https://docs.litmus.io/litmusedge-v2), [3.11.x and older](https://docs.litmus.io/litmusedge-v1) - [Litmus Edge Manager](https://docs.litmus.io/edgemanager) - [Litmus Unify](https://docs.litmus.io/unify) - current 2.0.x. Earlier version: [UNS 1.3.x](https://docs.litmus.io/uns) - [Solutions](https://docs.litmus.io/solutions) ## Build and automate - [Litmus API Portal](https://docs.litmus.io/api-docs) - REST and GraphQL reference for Edge, Edge Manager, and Unify - [Litmus SDK - Python](https://docs.litmus.io/sdk) - Python client and the litmus-cli command line tool - [Litmus MCP Server](https://docs.litmus.io/litmus-mcp-server) - Model Context Protocol server for AI agents ## Get help - [Support portal](https://support.litmus.io) - raise a ticket and track it - [Central Portal](https://portal.litmus.io) - downloads, licences, and your account Looking for the main documentation home page? Go to [docs.litmus.io](https://docs.litmus.io/). [space] Litmus API Portal (/api-docs) [title] Digital Twins [path] API Reference/ # Digital Twins (LE) 42 endpoints in 4.0.x. GraphQL on `/digitaltwins/v2`. Model hierarchical asset / data trees ("twins") that mirror physical equipment and roll up tag data. :::BlockQuote **Run these endpoints:** open the [Digital Twins folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#731012ed-3420-488c-8118-008c360625ea). ::: ## Capabilities - Define a **Model** (the schema / hierarchy template) - Instantiate a Model as a **Root Node**, then add **Child Nodes** under it - Bind nodes to DeviceHub tags - Query the tree (list, search, get-by-path) - Import / export models as JSON ## Typical operations | Operation | Purpose | | ---------------------------- | -------------------------------- | | `ListModels` | All models defined on the edge | | `CreateModel` | Define a new model schema | | `UpdateModel`, `DeleteModel` | Edit / remove | | `ImportModel`, `ExportModel` | JSON round-trip | | `CreateRootNode` | Instantiate a model | | `CreateNode` | Add a child node | | `GetNode`, `GetNodeByPath` | Read | | `UpdateNode`, `DeleteNode` | Mutate | | `BindTagToNode` | Attach a DeviceHub tag to a node | :::BlockQuote For the LEM counterpart (push twins to many edges), see [LEM Digital Twins / Asset Management](). ::: [title] Operations [path] / [title] DeviceHub Browse (Bulk Tag Discovery) [path] Workflows/ # DeviceHub Browse (Bulk Tag Discovery) **UI trigger**: DeviceHub -> Browse -> Select tags -> Create All. The Browse workflow auto-discovers a device's full address space (e.g. all OPC UA nodes or Modbus registers) and lets users select which ones to import as tags - without manually entering each one. ## Step table | Step | API Name | Method | Endpoint / GraphQL Operation | Input | Output / What to capture | | ---- | --------------------------------- | ------ | ---------------------------------------------------------------- | ---------------------------------- | ---------------------------------------------------------- | | 1 | Create Browse Task | `POST` | `{{edgeUrl}}/devicehub/v2` -> `CreateBrowseTask` | Device ID + browse params | Browse Task `ID` | | 2 | Start Browse Task | `POST` | `{{edgeUrl}}/devicehub/v2` -> `StartBrowseTasks` | Browse Task `ID` from step 1 | Task starts crawling | | 3 | List Browse Tasks (poll) | `POST` | `{{edgeUrl}}/devicehub/v2` -> `ListBrowseTasks` | - | Poll until `Status = Completed` | | 4 | Get Browse Task Folders | `POST` | `{{edgeUrl}}/devicehub/v2` -> `BrowseTask_GetFoldersForTreeView` | Browse Task `ID` | Folder tree of discovered address space | | 5 | Get Browse Folder Items | `POST` | `{{edgeUrl}}/devicehub/v2` -> `BrowseTask_GetFolderItems` | Folder path within the browse task | Items (tags/nodes) in that folder | | 6 | Cart Add Items | `POST` | `{{edgeUrl}}/devicehub/v2` -> `Cart_AddItems` | Selected item IDs from step 5 | Items added to cart (`Added`, `Skipped`, `Updated` counts) | | 6b | Cart Update Properties (optional) | `POST` | `{{edgeUrl}}/devicehub/v2` -> `Cart_UpdateProperties` | Cart item IDs + property overrides | Updated counts | | 7 | Cart Create All Registers | `POST` | `{{edgeUrl}}/devicehub/v2` -> `Cart_CreateAllRegisters` | No input - processes entire cart | `Created`, `Skipped`, `Updated` counts - tags now exist | ## Also useful `Download Browse Tags` (`GET /devicehub/browsing/download_csv/task/{task_id}`) exports discovered tags to CSV before committing. Lets users review in Excel before creating. ## Driver support Browse only works on drivers that support it (38 of \~146). OPC UA Advanced, AB Logix, Siemens S7CommPlus, and most modern Ethernet drivers do. Modbus (no enumeration capability), Generator (simulator), and several legacy serial drivers do not. See [Browse and Discovery]() for the support matrix. ## See also - [Browse and Discovery concept]() - [OPC UA Advanced Driver]() [title] Upload Custom CA Certificate (LE) [path] Workflows/ # Upload Custom CA Certificate (LE) **UI trigger**: System -> Network -> Certificates -> *Upload Custom CA Certificate*. :::BlockQuote No Step 0 here - the certificate store doesn't require clearing existing sessions first. ::: ## Step table | Step | Name in Collection | Method | Endpoint | Body / Notes | Output | | ---- | ------------------------------------ | ------ | -------------------------------------- | --------------------------------- | ----------------------------- | | 1 | Step 1: Upload Custom CA Certificate | `POST` | `{{edgeUrl}}/dm/certstore` | `{"size": }` | `{"id": ""}` | | 2 | Step 2: Upload Custom Certificate | `PUT` | `{{edgeUrl}}/dm/certstore/{upload_id}` | Binary `.pem` / `.crt` file bytes | 200 OK, certificate installed | Once installed, the edge can connect to internal services signed by your CA without `-k` / `verify=False` workarounds. See [SSL Certificates](). [title] SSL Certificates [path] Getting Started/ # SSL Certificates Litmus Edge ships with a self-signed certificate. Until you install your own CA, clients will reject the connection. ## Quick fix (development only) Disable certificate verification on the client: | Tool | Flag | | ---------------------- | --------------------------------------------------------- | | cURL | `-k` or `--insecure` | | Python `requests` | `verify=False` | | Postman | Settings -> General -> "SSL certificate verification" off | | Node `https` / `fetch` | `rejectUnauthorized: false` | ```bash curl -k "https:///devicehub/version" -H "Authorization: Bearer $TOKEN" ``` :::BlockQuote Never do this against production traffic. It opens you to MITM. ::: ## Production fix Install a CA-signed certificate on the edge: 1. System -> Network -> Certificates -> Upload Custom Certificate 2. Or use the Upload Custom CA Certificate workflow: see [Upload Custom CA Certificate (LE)](docId:28rH--yWuRRNllnEREt4Y) Once installed, drop `-k` / `verify=False` from your clients. ## Trusting the edge's self-signed cert If you don't want a public CA cert but still want clients to validate, export the edge's self-signed cert and add it to your client's trust store: ```bash echo | openssl s_client -connect :443 -servername 2>/dev/null \ | openssl x509 > edge.crt # Python export REQUESTS_CA_BUNDLE=$(pwd)/edge.crt # curl curl --cacert edge.crt "https:///devicehub/version" ... ``` [title] Resumable Uploads [path] Concepts/ # Resumable Uploads Litmus Edge uses a three-step resumable upload pattern for any operation that ingests a file: templates, backups, certificates, analytics models. The pattern is the same; only the path changes. ## The pattern | Phase | Method | What it does | Body | | ----------------- | -------- | ------------------------------------------ | ------------------- | | 0. Clear | `DELETE` | Remove any incomplete/stale upload session | none | | 1. Create session | `POST` | Declare file size, get a session `id` back | `{"size": }` | | 2. Upload | `PUT` | Stream the file bytes into the session | binary file body | :::BlockQuote **Why DELETE first?** If a previous upload was interrupted (network drop, browser close), the session persists on the server. Deleting it first ensures a clean state and prevents 409 Conflict. ::: ## Endpoints that use it | Workflow | Base path | Page | | ----------------------- | -------------------------------- | -------------- | | Apply / Upload Template | `/dm/template/v2` | [Workflow 1]() | | Restore Backup | `/dm/backup/v2` | [Workflow 2]() | | Upload Custom CA | `/dm/certstore` (no DELETE step) | [Workflow 3]() | | Upload Analytics Model | `/analytics/v2/upload_model/v2` | [Workflow 4]() | ## Step 2 (PUT) URL shapes The PUT URL is slightly different per module: | Module | PUT URL shape | | --------------- | --------------------------------------------------- | | Template | `/dm/template/v2/{session_id}/resume` | | Backup | `/dm/backup/v2/{session_id}/resume` | | Cert store | `/dm/certstore/{session_id}` (no `/resume` suffix) | | Analytics model | `/analytics/v2/upload_model/v2/resume/{session_id}` | ## Example: apply a template ```bash # Step 0: clear any stale session curl -X DELETE "$EDGE/dm/template/v2" \ -H "Authorization: Bearer $TOKEN" # Step 1: declare size SIZE=$(stat -c%s mytemplate.zip) ID=$(curl -sX POST "$EDGE/dm/template/v2" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d "{\"size\": $SIZE}" | jq -r .id) # Step 2: upload bytes curl -X PUT "$EDGE/dm/template/v2/$ID/resume" \ -H "Authorization: Bearer $TOKEN" \ --data-binary @mytemplate.zip ``` ## LEM uploads are different LEM does **not** use this pattern. LEM ML model upload uses a pre-signed S3 URL: 1. `POST .../mlModel/{filename}/upload-url` returns a signed S3 URL 2. `PUT ` uploads bytes **directly to S3** (no auth header needed - SigV4 is baked into the URL) 3. `POST .../mlModel/{filename}` commits / registers the model in LEM See [Upload AI/ML Model to LEM](). [title] Analytics [path] API Reference/ # Analytics (LE) 39 endpoints in 4.0.x. REST under `/analytics/...`. Run real-time computations on DeviceHub tag values - thresholds, aggregations, custom Python, and TensorFlow inference. :::BlockQuote **Run these endpoints:** open the [Analytics folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#cb468825-dca2-4803-94b7-fcafa4a08169). ::: ## Capabilities - **Processors**: per-tag or per-group calculation jobs (sliding-window aggregates, custom expressions) - **Groups**: group multiple tags for batch processing - **AI Models**: upload TensorFlow models, run inference against tag values ## Typical operations ### Processors | Endpoint | Purpose | | --------------------------------------- | ------- | | `GET /analytics/processors` | List | | `POST /analytics/processors` | Create | | `PUT /analytics/processors/{id}` | Update | | `DELETE /analytics/processors/{id}` | Delete | | `POST /analytics/processors/{id}/start` | Start | | `POST /analytics/processors/{id}/stop` | Stop | ### Groups | Endpoint | Purpose | | ------------------------------- | ------- | | `GET /analytics/groups` | List | | `POST /analytics/groups` | Create | | `PUT /analytics/groups/{id}` | Update | | `DELETE /analytics/groups/{id}` | Delete | ### AI Model upload (resumable, 3 steps) | Step | Method | Endpoint | | -------------- | ------ | ------------------------------------------------------ | | Clear | DELETE | `/analytics/v2/upload_model/v2` | | Create session | POST | `/analytics/v2/upload_model/v2` (body: `{size, name}`) | | Upload bytes | PUT | `/analytics/v2/upload_model/v2/resume/{id}` | See [Upload Analytics Model workflow](). [title] Error Handling [path] Operations/ # Error Handling How Litmus APIs report errors and what to do about them. ## REST: HTTP status codes Standard codes, used as you'd expect: | Code | Meaning | Common cause | | --------- | ---------------- | ------------------------------------------------------------ | | 200 / 201 | Success | -- | | 204 | No content | DELETE returned successfully | | 400 | Validation error | Bad body, missing required field | | 401 | Unauthorized | Token expired, wrong client\_id/secret, wrong header for LEM | | 403 | Forbidden | Token is valid but the user / client lacks permission | | 404 | Not found | Wrong path prefix or unknown resource ID | | 409 | Conflict | Resumable upload session already open (run DELETE first) | | 5xx | Server error | Check edge / LEM logs | Error body shape: ```json { "error": "", "message": "" } ``` ## GraphQL: 200 with errors array GraphQL endpoints (`/devicehub/v2`, `/digitaltwins/v2`, `/cc/v2`, `/opcua/v2`, `/mqtt/gql`) return HTTP 200 even on failure. Errors live in the body: ```json { "data": null, "errors": [ { "message": "Driver not found: 12345", "path": ["CreateDevice"], "extensions": { "code": "NOT_FOUND" } } ] } ``` **Always check **`body.errors`** before reading **`body.data` - a non-null `errors` array means the operation failed even though the HTTP status is 200. Some GraphQL responses return partial data alongside errors (e.g. one entry in a list failed). The contract is: data is what succeeded; errors lists what didn't. ## LEM async-task: per-subtask status LEM async-task subtasks each carry a `status`: | Status | Meaning | | ------------- | ------------------------------------------- | | `PENDING` | Queued, not started | | `IN_PROGRESS` | Running | | `SUCCESS` | Done OK | | `FAILED` | Done with error; check `errorMessage` field | A parent task can have some subtasks succeed and some fail. Inspect each subtask, don't aggregate. ## Common 401 traps | Product | Header | Wrong header symptom | | ---------------- | ------------------------------------------------ | --------------------------------------------------------- | | LE | `Authorization: Bearer ` | 401 with "invalid token" | | LEM `/api/v1/` | `X-AuthToken: ` | 401 - using `Bearer` returns "missing token" | | LEM `/admin/v1/` | `X-AuthToken: ` | Same as above | | LEM `/mpcs/` | `Authorization: ` (no `Bearer` prefix) | 401 if you add `Bearer` or use `X-AuthToken` | | LUNS | `Authorization: Bearer ` (Keycloak token) | 401 if you use the LE token instead of the UNS-issued one | ## Retries - **Idempotent ops** (GET, PUT, DELETE on a specific ID): safe to retry on 5xx and timeout. - **POST **`CreateX`: not safe to retry blindly - may create duplicates. Either retry with a client-side deduplication key or verify the resource via List before retrying. - **Async-task launch**: 5xx during step 3 = retry safe (no taskId returned). 5xx during polling = retry safe. - **Resumable uploads**: if step 2 (PUT bytes) fails, run step 0 (DELETE) and start over - the partial bytes are discarded. [title] Flows Manager [path] API Reference/ # Flows Manager (LE) 12 endpoints in 4.0.x. REST under `/flows/...`. Litmus Edge embeds a Node-RED-derived flow engine for low-code data routing and transformation. :::BlockQuote **Run these endpoints:** open the [Flows Manager folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#4eefb657-0cff-4940-9a75-cdb640195136). ::: ## Capabilities - List / create / update / delete flows - Import / export flow definitions as JSON - Start, stop, restart the flow engine - Inspect installed flow nodes ## Typical operations | Endpoint | Purpose | | ------------------------ | ------------------------- | | `GET /flows/list` | All flows | | `POST /flows` | Create a flow | | `PUT /flows/{id}` | Update | | `DELETE /flows/{id}` | Delete | | `POST /flows/import` | Import JSON | | `GET /flows/export/{id}` | Export JSON | | `POST /flows/start` | Start engine | | `POST /flows/stop` | Stop engine | | `GET /flows/nodes` | Installed flow node types | | `GET /flows/status` | Engine health | [title] Pagination [path] Operations/ # Pagination Conventions vary across modules and protocols. This page documents what's common and where exceptions live. ## REST list endpoints Most REST list endpoints accept query params: | Param | Default | Notes | | -------- | ----------- | ---------------------------------------------- | | `offset` | 0 | Zero-indexed | | `limit` | 50 (varies) | Max varies per endpoint; some allow up to 1000 | | `sort` | varies | `field:asc` / `field:desc` | | `filter` | none | Endpoint-specific | Response shape (typical): ```json { "items": [ ... ], "total": 1234, "offset": 0, "limit": 50 } ``` Use `total` to know how many pages remain. ## GraphQL list operations Most GraphQL list operations accept an `input` object: ```graphql query { ListDevices(input: { Limit: 100, Offset: 0, Filter: { Name: { Contains: "PLC" } }, Sort: [{ Field: "Name", Order: "ASC" }] }) { Items { ID Name } Total } } ``` Field casing follows the operation's schema (LE DeviceHub uses PascalCase; LEM uses camelCase). Check the operation on `api.litmus.io` to confirm. ## LEM async-task subtasks `GET /api/v1/async-task/{taskId}/subtasks` returns **all** subtasks - usually small, no pagination. `GET /api/v1/async-task/subtasks` (cross-task history) accepts `from` / `to` timestamp filters; pagination via `offset` and `limit`. ## When in doubt - The endpoint's example on `api.litmus.io` shows the actual parameter names and casing. - Default limits are conservative - prefer pagination over assuming "all rows fit". - For very large lists (e.g. tags across thousands of devices), filter at the source (`Filter` in GraphQL, query params in REST) instead of paginating the entire set. [title] Getting Started [path] / # Overview The Litmus APIs expose everything that powers the Litmus Edge UI, Litmus Edge Manager, and Litmus UNS. Anything you can do in the product UI can be done over the API. :::BlockQuote **Tip:** Once you have auth working, you can run every endpoint interactively at [Litmus API Portal](https://api.litmus.io/view/2s9Y5R1RvG) without writing any code. ::: ## Where to find what | You want... | Go to | | ---------------------------------------------------------------- | --------------------------------- | | Per-endpoint request / response schema, try-it-out, code samples | `https://api.litmus.io` | | Agent-readable endpoint catalog (LLMs, scripts) | `https://api.litmus.io/agents` | | Concepts, getting started, multi-step workflows (this site) | `https://docs.litmus.io/api-docs` | These three surfaces are designed to be used together. This site is the **navigation and concepts layer** that tells you how the products fit together and which endpoint to reach for; the visual portal at `api.litmus.io` is where you get the schema and run calls. ## What this site covers - How to authenticate (OAuth2 client credentials) - Base URLs and environment setup for each product - Section-level orientation per product / module - Multi-step workflows the UI runs behind a single button click (create-device-with-tags, browse-and-import, deploy-application, backup-restore, etc.) ## Who this is for - Integrators connecting Litmus Edge / Manager / UNS to external systems - Customers automating fleet operations (provisioning, app deploy, backups, alerts) - Solution engineers and partners building on top of Litmus ## What you need - A running Litmus Edge / LEM / UNS instance (cloud or on-prem) - OAuth2 client credentials (Admin generates these from the product UI) - An HTTP client - cURL, Postman, Python `requests`, or the Litmus Python SDK ## Next steps 1. [Authentication]() - obtain a Bearer token 2. [Base URLs and environments]() - what hostnames/paths to call 3. [First API call]() - confirm everything works end to end 4. [Try it live](https://api.litmus.io) [title] Base URLs and Environments [path] Getting Started/ # Base URLs and Environments Each product has its own host and URL conventions. The most common cause of "my call returns 404" is hitting the wrong base URL or prefix. ## Litmus Edge Single base URL, multiple module paths. | Module | Path prefix | Protocol | | -------------------------- | ----------------------------------------------------- | -------------- | | Auth | `/auth/v3/...` | REST | | DeviceHub | `/devicehub/v2` (GraphQL) and `/devicehub/...` (REST) | GraphQL + REST | | Digital Twins | `/digitaltwins/v2` | GraphQL | | DataHub | `/datahub/...` | REST | | Flows Manager | `/flows/...` | REST | | Analytics | `/analytics/...` | REST | | Applications | `/apps/...` | REST | | Integration | `/cc/v2` | GraphQL | | OPC UA | `/opcua/v2` | GraphQL | | System / Device Management | `/dm/...` | REST | In Postman / environment files this is `{{edgeUrl}}`. ## Litmus Edge Manager LEM has **three distinct host/path prefixes**: | Prefix | Used by | Roughly | Auth header | | ------------------------------- | ----------------------------------------------------------------------- | --------------- | ------------------------------------ | | `{{LEM_URL}}/api/v1/...` | Main fleet API (projects, devices, alerts, backups, marketplace deploy) | \~158 endpoints | `X-AuthToken` | | `{{LEM_adminURL}}/admin/v1/...` | Admin console (companies, users, LEM-level backups, instance alerts) | \~144 endpoints | `X-AuthToken` | | `{{LEM_URL}}/mpcs/...` | Marketplace catalog management | \~13 endpoints | `Authorization` (no `Bearer` prefix) | `{{LEM_adminURL}}` typically points to port 8446 on the LEM host. Confirm with your admin. ### Common LEM URL variables | Variable | Frequency | Notes | | ---------------------------------------- | --------- | --------------------------------- | | `{{project_id}}` | \~99 | LEM project the device belongs to | | `{{edge_device_id}}` | \~48 | Target edge device | | `{{company_name}}` | \~13 | Company (admin/v1 calls) | | `{{marketplace_catalog_id}}` | \~11 | Catalog under `/mpcs/` | | `{{marketplace_catalog_application_id}}` | \~10 | App in a marketplace catalog | ## Litmus UNS UNS is **GraphQL-only**. All operations target a single endpoint: ```javascript POST {{uns_url}}/mqtt/gql ``` The documented sections (Dashboard / UNS / Security / MQTT / Integrations / Tools) are organizational groupings - every request hits `/mqtt/gql` with a different GraphQL operation. There is no REST surface. ## Environment file template For Postman / scripts: ```javascript edgeUrl = https:// LEM_URL = https:// LEM_adminURL = https://:8446 uns_url = https:// client_id = client_secret = LEM_AdminApiToken = ``` [title] Authentication [path] Getting Started/ # Authentication All Litmus APIs use OAuth2 `client_credentials`. You exchange a `client_id` and `client_secret` for a short-lived Bearer token, then send that token on every subsequent API call. ## Litmus Edge ### Token endpoint ```javascript POST {{edgeUrl}}/auth/v3/oauth/token ``` :::BlockQuote Important: use `/auth/v3/oauth/token`. The Keycloak admin URL (`/auth/realms/...`) you may see in the Edge admin UI is **not** the API token endpoint. ::: ### Request ```bash curl -X POST "https:///auth/v3/oauth/token" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=client_credentials" \ -d "client_id=" \ -d "client_secret=" ``` ### Response ```json { "access_token": "eyJhbGciOi...", "token_type": "Bearer", "expires_in": 3600 } ``` ### Using the token ```bash curl "https:///devicehub/version" \ -H "Authorization: Bearer eyJhbGciOi..." ``` ## Litmus Edge Manager (LEM) LEM uses a long-lived admin API token rather than OAuth2 exchange. Generate one from the LEM Admin Console. Two headers are used depending on the endpoint prefix: | Endpoint prefix | Header | | --------------- | -------------------------------------- | | `/api/v1/...` | `X-AuthToken: ` | | `/admin/v1/...` | `X-AuthToken: ` | | `/mpcs/...` | `Authorization: ` (no `Bearer`) | :::BlockQuote Sending the wrong header returns 401. The `/mpcs/` marketplace endpoints use a plain `Authorization` header value, the other prefixes use `X-AuthToken`. See [LEM base URLs](). ::: ## Litmus UNS UNS uses OAuth2 password grant against its bundled Keycloak. ```javascript POST {{uns_url}}/auth/realms/standalone/protocol/openid-connect/token ``` Body (form-encoded): `grant_type=password`, `client_id`, `username`, `password`. The returned `access_token` is sent as `Authorization: Bearer ` on every `/mqtt/gql` GraphQL call. ## Token lifetime and refresh - LE tokens default to 1 hour (`expires_in: 3600`). Re-fetch before expiry. - LEM admin tokens are long-lived; rotate via the Admin Console. - UNS tokens follow the Keycloak realm policy (typically 15-60 minutes). ## Where to get credentials | Product | Where | | ----------- | ------------------------------------------------- | | Litmus Edge | System -> Settings -> Users -> API Clients | | LEM | Admin Console -> API Tokens | | LUNS | Admin -> Users (use the configured Keycloak user) | [title] First API Call [path] Getting Started/ # Your First API Call A 60-second sanity check: get a token, hit one endpoint, see a 200. :::BlockQuote **Run this call live:** every example on this page also lives in the [Litmus API collection](https://api.litmus.io/view/2s9Y5R1RvG). Open the collection, fork it, paste your token, and hit Send. ::: ## 1. Get a token ```bash TOKEN=$(curl -sk -X POST "https:///auth/v3/oauth/token" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=client_credentials" \ -d "client_id=$CLIENT_ID" \ -d "client_secret=$CLIENT_SECRET" | jq -r .access_token) ``` `-k` skips TLS verification - use only against self-signed dev instances. See [SSL Certificates]() before doing this in production. ## 2. Call a read-only endpoint ```bash curl -sk "https:///devicehub/version" \ -H "Authorization: Bearer $TOKEN" ``` Expected: a JSON object with a `Version` field. If you see this, auth and routing work. ## 3. Try a GraphQL call DeviceHub is GraphQL. List drivers on the edge: ```bash curl -sk -X POST "https:///devicehub/v2" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"query":"query { ListDriverGroups { ID Name Drivers { ID Name } } }"}' ``` :::BlockQuote GraphQL endpoints return HTTP 200 even on errors. Check the `errors` key in the response body, not just the status code. See [GraphQL vs REST](). ::: ## Python equivalent ```python import os, requests EDGE = os.environ["EDGE_URL"] r = requests.post( f"{EDGE}/auth/v3/oauth/token", data={ "grant_type": "client_credentials", "client_id": os.environ["CLIENT_ID"], "client_secret": os.environ["CLIENT_SECRET"], }, verify=False, ) token = r.json()["access_token"] v = requests.get(f"{EDGE}/devicehub/version", headers={"Authorization": f"Bearer {token}"}, verify=False) print(v.json()) ``` ## Troubleshooting | Symptom | Likely cause | | -------------------------------- | ---------------------------------------------------------------------------------------------- | | `401 Unauthorized` | Token expired, wrong client\_id/secret, or wrong header (LEM uses `X-AuthToken`, not `Bearer`) | | `404 Not Found` | Wrong base URL or path prefix - see [Base URLs]() | | `SSL: CERTIFICATE_VERIFY_FAILED` | Self-signed cert - see [SSL Certificates]() | | GraphQL returns 200 but no data | Check `errors` key in the body, not just HTTP status | [title] Products [path] / # Products Litmus offers three products, each with its own API surface. They are designed to work together (edges register with the manager, edges and the manager publish to UNS), but each can also be used standalone. Every endpoint in every product is also runnable in the [Litmus API Portal](https://api.litmus.io), our executable Postman collection. ## Product Matrix | Product | What it does | API style | Versions covered | Run live | | ----------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------- | | **Litmus Edge** (LE) | On-device runtime. Connects to industrial assets, normalises tags, runs analytics, flows, and applications. | REST + GraphQL | 4.0.x, 3.16.x | [Litmus API Portal: Litmus Edge folder](https://api.litmus.io/view/2s9Y5R1RvG#997384db-8d7d-4df6-bf13-a125f5883106) | | **Litmus Edge Manager** (LEM) | Fleet control plane. Edge provisioning, app deployment, backups, alerts, asset hierarchy across many edges. | REST (3 prefixes) | 2.31.x, 2.26.x | [Litmus API Portal: Edge Manager folder](https://api.litmus.io/view/2s9Y5R1RvG#fa19f00d-c1ae-4dfd-8b3a-08698c2c9c59) | | **Litmus Unify** (LUNS) | Unified namespace and MQTT broker. Canonical hierarchy of every tag in your operation, with ACL management. | GraphQL only | Current | [Litmus API Portal: Litmus Unify folder](https://api.litmus.io/view/2s9Y5R1RvG#c3f795a0-533e-4e2d-ae41-27c1986faace) | ## Endpoint Counts Counts are pulled from the live collection on the [Litmus API Portal](https://api.litmus.io). They drift only when a new product version ships. ### Litmus Edge | Service | 4.0.x | 3.16.x | | ------------- | ------- | ------- | | Dashboard | 22 | 22 | | DeviceHub | 342 | 35 | | Digital Twins | 42 | 38 | | DataHub | 16 | 16 | | Flows Manager | 12 | 6 | | Analytics | 39 | 15 | | Applications | 69 | 69 | | Integration | 112 | 29 | | OPC UA | 27 | 27 | | System | 185 | 180 | | **Total** | **866** | **437** | ### Litmus Edge Manager | Service | 2.31.x | 2.26.x | | -------------------------------- | ------- | ------- | | Companies | 5 | 5 | | Edge Lifecycle Management | 144 | 134 | | Digital Twins / Asset Management | 9 | 8 | | Admin Console APIs | 146 | 115 | | **Total** | **304** | **262** | ### Litmus Unify | Service | Current | | ------------ | ------- | | Dashboard | 4 | | UNS | 7 | | Security | 10 | | MQTT | 4 | | Integrations | 2 | | Tools | 1 | | **Total** | **28** | ## Where to Start - Building or controlling **one** edge runtime: read the [Litmus Edge product page](), then run endpoints in the [Litmus API Portal](https://api.litmus.io/view/2s9Y5R1RvG#997384db-8d7d-4df6-bf13-a125f5883106). - Managing **many** edges across sites or customers: read the [Litmus Edge Manager product page](), then [run endpoints](https://api.litmus.io/view/2s9Y5R1RvG#fa19f00d-c1ae-4dfd-8b3a-08698c2c9c59). - Publishing into or querying the **Unified Namespace**: read the [Litmus Unify product page](), then [run endpoints](https://api.litmus.io/view/2s9Y5R1RvG#c3f795a0-533e-4e2d-ae41-27c1986faace). - End-to-end recipes that span products: see [Workflows]() here, or [47 worked examples in the Litmus API Portal](https://api.litmus.io/view/2s9Y5R1RvG#e7f328dd-c01f-496b-8f61-927ac6d619e8). - Already know the endpoint you need? Skip the narrative and [open the Litmus API Portal](https://api.litmus.io). [title] Litmus Unify [path] Products/ # Litmus Unify (LUNS) Litmus UNS is the Unified Namespace - an MQTT broker plus structured namespace plus account / ACL management plane. Edges publish here; downstream systems subscribe. ## GraphQL-only LUNS exposes a **single endpoint** for all operations: ```javascript POST {{uns_url}}/mqtt/gql ``` All 28 documented endpoints share this URL. The folder structure in the API portal (Dashboard / UNS / Security / MQTT / Integrations / Tools) is organizational - the actual operation is in the GraphQL query/mutation body. :::BlockQuote There is no REST surface for LUNS. If a tutorial tells you to call `POST /uns/account`, that's wrong - it's `POST /mqtt/gql` with a `createAccount` mutation in the body. ::: ## Module map (logical, not URL) | Section | Purpose | Endpoints | | ------------ | ----------------------------------------------- | --------- | | Dashboard | Broker stats, connected client counts | 4 | | UNS | Namespace hierarchy, models, instances | 7 | | Security | Accounts, ACL rules, tokens, LE activation | 10 | | MQTT | Topic listing, retained messages, broker config | 4 | | Integrations | Bridges to external brokers / cloud | 2 | | Tools | Diagnostics, exports | 1 | ## Auth OAuth2 password grant against the embedded Keycloak: ```javascript POST {{uns_url}}/auth/realms/standalone/protocol/openid-connect/token ``` Form body: `grant_type=password`, `client_id`, `username`, `password`. The returned `access_token` is sent as `Authorization: Bearer ` on every `/mqtt/gql` call. ## First call ```bash curl -sk -X POST "https:///mqtt/gql" \ -H "Authorization: Bearer $UNS_TOKEN" \ -H "Content-Type: application/json" \ -d '{"query":"query { account { id username acType enabled } }"}' ``` ## Common operations | Operation | GraphQL | | -------------------------- | --------------------------------------------------------- | | List accounts | `query { account { ... } }` | | Create account | `mutation { createAccount(input: { ... }) { id } }` | | Add ACL rule | `mutation { addAccountRules(input: { ... }) }` | | Enable account | `mutation { enableAccount(input: { accountId: "..." }) }` | | Create LE activation token | `mutation { createLitmusEdgeActivationToken(...) }` | See [Provision UNS MQTT Account]() for the full create-account chain. [title] Litmus Edge Manager [path] Products/ # Litmus Edge Manager (LEM) LEM is the fleet management plane for Litmus Edges. Use it to provision new devices, deploy applications and ML models to many devices at once, run alerts, and back up / restore device configurations. :::BlockQuote **Run all 304 Edge Manager endpoints:** browse and execute them in the [Edge Manager folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#fa19f00d-c1ae-4dfd-8b3a-08698c2c9c59). ::: ## Three URL prefixes LEM has **three distinct host/path prefixes** that customers commonly confuse: | Prefix | Purpose | Endpoints | Auth header | | ------------------------------- | ------------------------------------------------------------------- | --------- | -------------------------------------- | | `{{LEM_URL}}/api/v1/...` | Main fleet API: projects, devices, alerts, backups, deploy | \~158 | `X-AuthToken: ` | | `{{LEM_adminURL}}/admin/v1/...` | Admin console: companies, users, LEM-level backups, instance alerts | \~144 | `X-AuthToken: ` | | `{{LEM_URL}}/mpcs/...` | Marketplace catalog management | \~13 | `Authorization: ` (no `Bearer`) | `{{LEM_adminURL}}` typically uses port 8446. Sending the wrong header returns 401. ## Module map ### Companies (admin console) | Endpoint | Purpose | | -------------------------- | ---------------- | | `GET /admin/v1/companies` | List companies | | `POST /admin/v1/companies` | Create a company | ### Edge Lifecycle Management (`/api/v1/...`) The bulk of LEM (\~144 endpoints in 2.31.x). Grouped sub-modules: - Projects, Users - Activation (zero-touch + manual approval) - Devices (list, detail, edit, retire) - Marketplace deploy (catalogs, applications, async-task) - Backups (`init-backup`, `list`, `get`, `init-restore`) - Alerts (action templates + triggers + incidents) - AI/ML model upload (pre-signed S3) - Software / firmware update history ### Digital Twins / Asset Management - Models, root nodes - Asset hierarchies pushed down to edges ## Versions documented | Version | Endpoints | Notes | | ------- | --------- | --------- | | 2.31.x | 304 | Current | | 2.26.x | 262 | Older LTS | ## Common URL variables | Variable | Used in | Notes | | ---------------------------- | --------------------- | ------------------------------------------------ | | `{{project_id}}` | Most `/api/v1/` calls | LEM project the device belongs to | | `{{edge_device_id}}` | Device-specific calls | Renamed from `device_id` to disambiguate from LE | | `{{company_name}}` | `/admin/v1/` calls | Company under which projects live | | `{{marketplace_catalog_id}}` | `/mpcs/` calls | Catalog of available apps | | `{{LEM_AdminApiToken}}` | All calls | Long-lived admin token from Admin Console | ## Async-task envelope LEM long-running operations (app launch, ML deploy, software update) follow the same pattern: 1. POST a task description -> get `taskId` 2. Poll `GET /api/v1/async-task/{taskId}/subtasks` until each subtask `status == SUCCESS` States: `PENDING`, `IN_PROGRESS`, `SUCCESS`, `FAILED`. See [Deploy App to Edge workflow](). [title] Litmus Edge [path] Products/ # Litmus Edge (LE) Litmus Edge is the on-prem runtime that connects to industrial assets (PLCs, sensors, OPC servers, databases, MQTT brokers), normalizes the data, and routes it through analytics, apps, and integrations. :::BlockQuote **Run all Litmus Edge endpoints:** browse and execute them in the [Litmus Edge folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#997384db-8d7d-4df6-bf13-a125f5883106). ::: ## Module map | Module | Purpose | Protocol | Base path | | ------------- | ---------------------------------------------------------- | -------------- | --------------------------------- | | Dashboard | Liveness / utilization / counts | REST | `//status` (varies) | | DeviceHub | Devices, drivers, tags, browse, asset discovery | GraphQL + REST | `/devicehub/v2`, `/devicehub/...` | | Digital Twins | Hierarchical asset / data models | GraphQL | `/digitaltwins/v2` | | DataHub | Internal data routing and storage configuration | REST | `/datahub/...` | | Flows Manager | Node-RED-style data flows | REST | `/flows/...` | | Analytics | TensorFlow models, processors, groups | REST | `/analytics/...` | | Applications | Edge app catalog and lifecycle | REST | `/apps/...` | | Integration | Cloud / database connectors (45 providers) | GraphQL | `/cc/v2` | | OPC UA | Built-in OPC UA server (re-export DH tags) | GraphQL | `/opcua/v2` | | System | Device management, network, certificates, backup, template | REST | `/dm/...`, `/auth/v3/...` | ## Versions documented ### LE 4.0.x (866 endpoints) The current series. All modules above are fully documented. New in 4.0 vs 3.16: - Integration: 112 endpoints (up from 29) - includes 45 Provider Schemas Reference + 45 Create Instance Provider Examples - DeviceHub: 342 endpoints (up from 35) - includes 146 Create Device driver examples + 146 Register Types driver references - Analytics, Flows, Digital Twins, Dashboard expanded ### LE 3.16.x (437 endpoints) Older LTS. Same module structure, smaller per-module coverage. Use this version if your fleet is on 3.16; otherwise prefer 4.0.x. ## Auth OAuth2 client\_credentials at `{{edgeUrl}}/auth/v3/oauth/token`. See [Authentication](). ## Common entry points - Health check: `GET /devicehub/version` - List drivers: GraphQL `ListDriverGroups` at `/devicehub/v2` - List configured devices: GraphQL `Devices` at `/devicehub/v2` - Dashboard snapshot: `GET /dashboard/...` (per-module status endpoints) [title] Browse and Discovery [path] Concepts/ # Browse and Asset Discovery Two different "discovery" features exist in Litmus Edge. Don't confuse them. ## 1. Asset Discovery (network-level) Scans your **network** for assets that aren't yet configured in DeviceHub. Returns IP addresses, vendor / model hints, and protocol guesses. - API folder: DeviceHub -> Asset Discovery - Per-interface scan: eth0, wlan0, etc. - Operations: `GET /devicehub/assetdiscovery/...` (REST) - Enable / disable scanning per interface Use when: "I have a new PLC plugged into the same VLAN - what's its IP and what protocol does it speak?" ## 2. Browse (device-level) Walks the **address space of an already-configured device** and surfaces tags / nodes you can import. - API folder: DeviceHub -> Browse - GraphQL operations on `/devicehub/v2` - Operates against a Device ID (the device must already exist) Use when: "I have an OPC UA server configured - show me every node so I can pick which ones to monitor." ## Browse modes per driver The 146 drivers vary in what they support: | Mode | What it does | Drivers | | ------------- | ----------------------------------------------- | --------------------------------------------------------- | | Browse | One-shot full address space walk | OPC UA Advanced, AB Logix, Siemens S7CommPlus, \~38 total | | DynamicBrowse | Re-browse on demand for changing address spaces | Subset of Browse-capable drivers | | StreamBrowse | Incremental walk for large servers | OPC UA Advanced primarily | Drivers without Browse support (e.g. Modbus, since Modbus has no enumeration capability) cannot use the Browse chain - tags must be created directly via `CreateRegisters`. :::BlockQuote The Generator driver (simulator) doesn't support Browse either. If you're using the Generator for testing, skip the Browse chain. ::: ## Browse workflow ```javascript CreateBrowseTask -> StartBrowseTasks -> [poll] ListBrowseTasks -> BrowseTask_GetFoldersForTreeView -> BrowseTask_GetFolderItems -> Cart_AddItems (optional Cart_UpdateProperties) -> Cart_CreateAllRegisters ``` 7 steps, all on `/devicehub/v2`. See [Browse - Bulk Tag Discovery workflow](). ## Useful side endpoints - `Download Browse Tags` (`GET /devicehub/browsing/download_csv/task/{task_id}`) - exports discovered tags to CSV before committing. Lets users review in Excel before creating. - `Upload CSV` (REST) - import tags from CSV (skip Browse entirely if you already have the spreadsheet). [title] Integration Providers [path] Concepts/ # Integration Providers The Integration module (`/cc/v2`, internally called "cc" for connector cloud) routes Litmus Edge data to external systems: cloud queues, time-series DBs, SQL databases, MQTT brokers, file stores. 45 providers are documented. ## How an instance is built Creating an integration instance is a two-step GraphQL chain: 1. `GetProviderSchema(ProviderID: "...")` - returns the full config schema for that provider (field names, types, required, defaults, enums). 2. `CreateInstance(ProviderID: "...", Config: { ... })` - submits a config matching the schema, gets back an `InstanceID`. Then you create one or more subscriptions to route tag data into the instance: 3. `CreateSubscription(InstanceID, Topic, ...)` - data starts flowing. See [Create Integration Instance workflow]() for the full chain. ## Reference sections on the API portal The API portal at `api.litmus.io` includes two cross-referenced sections, one entry per provider: - **Provider Schemas - Reference** (45 entries) - one canonical `GetProviderSchema` response per provider. Use as a lookup for valid config fields. - **Create Instance - Provider Examples** (45 entries) - one canonical `CreateInstance` mutation per provider, with a working config body. Together, they let you copy a working example and adapt it. ## The 45 providers Grouped by category: ### Cloud queues / streaming - AMQP (SSL / TCP) - AWS IoT Core, AWS SiteWise - Azure Event Hubs, Azure IoT Hub - Google Cloud Pub/Sub - IBM Watson - Kafka (SSL / TCP / Gen 2) - MQTT (Generic / v5 / SSL) - NATS - Splunk ### Time-series and data lakes - Aveva Data Hub - Cognite - Databricks SQL - InfluxDB (v1.7 / v2) - OSI PI Historian - Snowflake ### Databases - MongoDB (v4+) - MySQL - PostgreSQL - SQL Server - Oracle Fusion Cloud ### Other - Litmus UNS - REST API (generic outbound HTTP) ## Browse support matrix Out of \~146 drivers, 38 support Browse. The **Browse** section on `api.litmus.io` includes the full support matrix in its description. Common Browse-capable drivers: - OPC UA Client Advanced (Browse + DynamicBrowse + StreamBrowse) - All Allen-Bradley CompactLogix/ControlLogix variants - Siemens S7CommPlus, iQ-R, iQ-F - Modbus TCP (limited - discovers configured registers, not new ones) - MQTT Client, REST Client (DynamicBrowse for topic / endpoint discovery) ## See also - [Create Integration Instance workflow]() - [Integration API Reference]() [title] GraphQL vs REST [path] Concepts/ # GraphQL vs REST Litmus uses both. Knowing which module is which prevents the most common 200-with-no-data confusion. ## Which modules use which | Module | Protocol | | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | | LE DeviceHub | GraphQL at `/devicehub/v2` (most ops); a few REST endpoints for CSV upload/download and storage toggle | | LE Digital Twins | GraphQL at `/digitaltwins/v2` | | LE Integration | GraphQL at `/cc/v2` | | LE OPC UA | GraphQL at `/opcua/v2` | | LE DataHub, Flows, Analytics, Applications, System, Auth | REST | | LEM (all modules) | REST | | LUNS (all modules) | GraphQL at `/mqtt/gql` | ## GraphQL gotchas ### 1. Error envelope GraphQL endpoints return **HTTP 200** even on validation errors. The error sits in the body: ```json { "data": null, "errors": [ { "message": "Driver not found", "path": ["CreateDevice"] } ] } ``` Your client must check `body.errors`, not just the HTTP status. Treat `errors` being a non-empty array as a failure. ### 2. Operation name is in the body REST callers think in URLs. GraphQL callers think in operations. The URL stays the same; the *query* or *mutation* selects the action: ```bash # Same URL, two different operations: curl -X POST .../devicehub/v2 -d '{"query":"query { ListDriverGroups { ... } }"}' curl -X POST .../devicehub/v2 -d '{"query":"mutation { CreateDevice(input: {...}) { ID } }"}' ``` ### 3. Field selection is required You must explicitly name the fields you want back. Asking for everything in a single query is not idiomatic - request only what you'll read. ### 4. Pagination, filtering, sorting These vary per operation. Most list operations accept an `input` argument with `Limit`, `Offset`, `Filter`, `Sort` fields. Check the operation's schema before assuming defaults. ## REST conventions in Litmus - Path-versioned: `/devicehub/v2`, `/digitaltwins/v2`, `/dm/template/v2` - new major versions don't break old clients. - Resumable uploads: `DELETE` -> `POST {size}` -> `PUT {bytes}` pattern. See [Resumable Uploads](). - Async tasks (LEM): `POST` returns `taskId`, then `GET /async-task/{id}/subtasks` polls until `SUCCESS`. - Standard HTTP status codes - 200/201 success, 400 validation, 401 auth, 403 forbidden, 404 missing, 5xx server. ## How to spot GraphQL vs REST on the API portal Browsing `api.litmus.io`: - GraphQL requests show as `POST` with a JSON body containing `query` and optional `variables`. - REST requests show varied HTTP methods and typed bodies. - Look at the URL: anything ending in `/v2` with no further path (`/devicehub/v2`, `/cc/v2`, `/opcua/v2`, `/digitaltwins/v2`, `/mqtt/gql`) is GraphQL. [title] DeviceHub [path] Concepts/ # DeviceHub DeviceHub is the heart of Litmus Edge. Understanding its data model makes the rest of the API obvious. ## The hierarchy ```javascript Driver Group (Modbus, OPC UA, AB EthernetIP, ...) └── Driver (Modbus TCP, OPC UA Client Advanced, ...) └── Device (one configured connection to an asset) └── Tag / Register (one data point on that asset) └── Value (live + historical) ``` | Concept | What it is | Created by | | -------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------- | | Driver Group | Protocol family (Modbus, OPC UA, AB, Siemens, etc.) | Litmus (fixed list) | | Driver | Specific implementation within a family (Modbus TCP vs Modbus RTU vs Modbus UDP) | Litmus (fixed list, \~146 drivers) | | Device | A configured instance of a driver pointing at a physical asset (IP, port, credentials, polling rate) | User | | Tag / Register | A single data point on the device (e.g. Modbus holding register 40001) | User | | Value | Time-series data captured by polling the tag | DeviceHub runtime | ## Why each layer matters for the API | You want to... | First find the... | | ----------------------------- | ------------------------------------------------------------ | | Create a device | Driver ID (from `ListDriverGroups`) | | Know what tag types are valid | Driver's `SupportedRegisters` (varies per driver) | | Create a tag | Device ID **and** the register type for that device's driver | | Browse for tags automatically | Device must already exist (Browse runs against a device) | ## API entry points | Operation | GraphQL on `/devicehub/v2` | | -------------------------------------------------------------- | ----------------------------------------------- | | List driver families and their drivers | `ListDriverGroups` | | Get one driver's template (config fields, supported registers) | `GetDriver` with `ID: ""` | | Create a device | `CreateDevice` | | Start / stop a device | `StartDevice` / `StopDevice` | | Create a tag on a device | `CreateRegisters` | | List tags | `ListRegisters` | | Validate a tag payload before creating | `ValidateUpdateRegisters` | | Browse the device's address space | `CreateBrowseTask` -> `StartBrowseTasks` -> ... | ## Driver IDs you'll see often | Driver | ID | | ------------------------------------------- | -------------------------------------- | | Generator (simulator, useful for testing) | `5BC98836-CFD4-11E9-BB65-2A2AE2DBCCE4` | | OPC UA Client Advanced (recommended OPC UA) | `2372E68F-BA1B-46E9-BC07-E92CA006B377` | Use `ListDriverGroups` to discover the rest live; IDs are stable. ## See also - [Create Device + Tags workflow]() - [Browse - Bulk Tag Discovery workflow]() - [OPC UA Advanced Driver]() [title] Concepts [path] / [title] Create LEM Project Alert (Trigger + Action) [path] Workflows/ # Create LEM Project Alert (Trigger + Action) **UI trigger**: LEM -> Edge Lifecycle Management -> Alerts -> *Add Action* -> *Add Trigger*. A LEM alert has two halves that must be created in order: the **action template** (how to notify - email, Slack, webhook, PagerDuty) is created first and returns an `id`; the **trigger** (when to fire - metrics threshold or event match) references that `id` in its `actions` array. ## Step table | Step | Name in Collection | Method | Endpoint | Body / Notes | Output | | ---------- | --------------------------------------------------- | ------ | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | | 1 | Add Action - Email (or Slack / Webhook / PagerDuty) | `POST` | `{{LEM_URL}}/api/v1/project/action/templates/{{project_id}}` | Body shape varies by channel; see saved examples | Action `id` (e.g. `bp0pgdjum4l1ltore344h9j1p`) | | 2 | Project Triggers (optional pre-flight) | `GET` | `{{LEM_URL}}/api/v1/project/trigger/definition` | -- | Existing triggers (avoid duplicates) | | 3 | Create Trigger - Metrics (or Event) | `POST` | `{{LEM_URL}}/api/v1/project/trigger/definition/{{project_id}}` | Body must include `actions: [""]`. Set `sourceType: "METRICS"` or `"EVENTS"`, `scopeType: "USER"` or `"PROJECT"`, `deviceId: null` (all devices) or specific deviceId | Trigger `id` | | 4 (verify) | List of Incidents | `GET` | `{{LEM_URL}}/api/v1/project/incident/{{project_id}}` | Incidents accumulate as triggers fire | Incident list with severity, timestamp, action result | ## Cleanup | Operation | Endpoint | | -------------- | ------------------------------------------------------------------------- | | Delete Action | `DELETE /api/v1/project/action/templates/{{project_id}}/{{alert_id}}` | | Delete Trigger | `DELETE /api/v1/project/trigger/definition/{{project_id}}/{{trigger_id}}` | ## Project alerts vs Instance alerts This chain creates **project-scoped** alerts that notify project members about edge metric/event conditions. For **LEM-instance-level** alerts (notify ops about LEM itself), use the parallel chain at `/admin/v1/instance-alert/trigger/...` and `/admin/v1/instance-alert/action/templates/...`. [title] Upload Analytics / TensorFlow Model (LE) [path] Workflows/ # Upload Analytics / TensorFlow Model (LE) **UI trigger**: Analytics -> Models -> *Add AI Model*. :::BlockQuote Step 1 here is a `DELETE` (same clear-first pattern as Template/Backup), but is labeled "Step 1" instead of "Step 0" on `api.litmus.io`. ::: ## Step table | Step | Name in Collection | Method | Endpoint | Body / Notes | Output | | ---- | ------------------------------- | -------- | ------------------------------------------------------------- | ----------------------------------------------------- | ----------------------- | | 1 | Step 1: Upload TensorFlow Model | `DELETE` | `{{edgeUrl}}/analytics/v2/upload_model/v2` | No body. Clears existing upload session. | 200 OK | | 2 | Step 2: Upload TensorFlow Model | `POST` | `{{edgeUrl}}/analytics/v2/upload_model/v2` | `{"size": , "name": ".zip"}` | `{"id": ""}` | | 3 | Step 3: Upload TensorFlow Model | `PUT` | `{{edgeUrl}}/analytics/v2/upload_model/v2/resume/{upload_id}` | Binary `.zip` model file bytes | 200 OK, model stored | After upload, bind the model to a processor via `POST /analytics/processors`. See [Analytics reference](). [title] Overview [path] / # Litmus API Portal The Litmus API Portal is the central reference for all Litmus Edge, Litmus Edge Manager (LEM), and Litmus UNS APIs. Whether you're automating device provisioning, building custom integrations, querying live industrial data, or embedding Litmus capabilities into your own applications, this portal has everything you need to get started and go deep. APIs are available as both REST and GraphQL endpoints. The portal covers authentication, base URLs, error handling, pagination, and deprecation policies, as well as full API reference documentation organized by product and service. ::::BlockQuote **Looking for the interactive API?**This site is the narrative documentation. For the executable Postman collection of all 1,944 endpoints plus AI-agent surfaces, visit [https://api.litmus.io](https://api.litmus.io).:::Paragraph{listStyleType="disc" indent="1"} [Interactive API collection](https://api.litmus.io/view/2s9Y5R1RvG) - run any endpoint ::::::Paragraph{listStyleType="disc" listStart="2" indent="1"} [AI agent routes](https://api.litmus.io/agents) - LLM-optimised router tree ::::::Paragraph{listStyleType="disc" listStart="3" indent="1"} [MCP manifest](https://api.litmus.io/mcp-agents.md) - tool calls for AI agents ::::::Paragraph{listStyleType="disc" listStart="4" indent="1"} [Python SDK docs](https://api.litmus.io/sdk-agents.md) - scripting reference ::::::Paragraph{listStyleType="disc" listStart="5" indent="1"} [llms.txt](https://api.litmus.io/llms.txt) - site index for LLMs ::: :::: ## What's Covered - **Litmus Edge API**: DeviceHub, Digital Twins, DataHub, Flows Manager, Analytics, OPC UA, Marketplace, System, and Workflows - **Litmus Edge Manager API:** device provisioning, alerts, project management, and the LEM Bridge - **Litmus UNS API:** account provisioning and Unified Namespace data access - **Authentication**: OAuth2 tokens, API keys, and SSL certificate configuration - **GraphQL vs REST:** guidance on when to use each interface - **Resumable Uploads:** for large files such as ML models, backups, and CA certificates - **Integration Providers:** connecting external systems via the Litmus Edge integration layer ## Common API Workflows The portal includes step-by-step walkthroughs for the most common automation tasks: - Create a DeviceHub device with tags - Deploy an edge application to a device - Configure an OPC UA server - Provision a new edge device via LEM - Upload an AI/ML model to LEM - Create a project alert with trigger and action - Backup and restore a Litmus Edge instance - Provision a UNS account ## Getting Started New to the Litmus API? Start here: - **Authentication**: generate your OAuth2 token or API key - **Base URLs & Environments**: find the right endpoint for your Litmus instance - **First API Call**: make a test request in under five minutes - **SSL Certificates**: configure certificate validation for self-hosted deployments ## API Reference The full API reference is organized by service module. Each section documents available endpoints, request parameters, response schemas, and example payloads. Browse by product — Litmus Edge, Edge Manager, or UNS — or navigate directly to a service area: DeviceHub, Digital Twins, DataHub, Flows Manager, Analytics, OPC UA, System, or Marketplace. [title] Workflows [path] / # Workflows The 15 multi-step API chains that the Litmus UI orchestrates behind a single user action. This is the most valuable section of the docs - none of these workflows can be reconstructed from a single endpoint reference. :::BlockQuote **Run any workflow live:** all 47 chains are in the [How-to folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#e7f328dd-c01f-496b-8f61-927ac6d619e8). ::: Each workflow page includes: - The UI action that triggers it - A step-by-step table (method, endpoint, body, output) - Auth notes per step (which header, which token) - Variants and cleanup steps ## All workflows | # | Workflow | Product | Steps | Protocol | | -- | -------------------------------------------------- | ------- | ----- | --------- | | 1 | [Apply / Upload Template]() | LE | 3 | REST | | 2 | [Restore Backup]() | LE | 3 | REST | | 3 | [Upload Custom CA Certificate]() | LE | 2 | REST | | 4 | [Upload Analytics / TensorFlow Model]() | LE | 3 | REST | | 5 | [Upload AI/ML Model to LEM]() | LEM | 3 | REST + S3 | | 6 | [Create DeviceHub Device + Tags]() | LE | 5 | GraphQL | | 7 | [DeviceHub Browse (Bulk Tag Discovery)]() | LE | 7 | GraphQL | | 8 | [Deploy Edge Application]() | LE | 4 | REST | | 9 | [Configure OPC UA Server with Tags]() | LE | 4 | GraphQL | | 10 | [Create Integration Instance]() | LE | 4 | GraphQL | | 11 | [Provision New Edge Device (Zero-Touch)]() | LEM | 5 | REST | | 12 | [Deploy Application to Edge Device (Async-Task)]() | LEM | 5 | REST | | 13 | [Backup and Restore an Edge Device from LEM]() | LEM | 5 | REST + S3 | | 14 | [Create LEM Project Alert (Trigger + Action)]() | LEM | 4 | REST | | 15 | [Provision a UNS MQTT Account]() | LUNS | 5 | GraphQL | ## Pattern: Resumable Upload Sessions Workflows 1-4 share the same resumable upload pattern: | Phase | Method | What it does | | ----------------- | -------- | ----------------------------------- | | 0. Clear | `DELETE` | Remove any stale upload session | | 1. Create session | `POST` | Declare file size, get a session ID | | 2. Upload | `PUT` | Stream the bytes | See [Resumable Uploads](). ## Pattern: LEM Async-Task Workflows 11-13 use the LEM async-task envelope: ```javascript POST .../async-task/task-with-subtasks -> { taskId } GET .../async-task/{taskId}/subtasks -> poll until SUCCESS ``` [title] Provision UNS Account [path] Workflows/ # Provision a UNS MQTT Account **UI trigger**: LUNS -> Security -> *Create Account* -> *Add Permissions*. Creates an MQTT account on the LitmusUNS broker, sets its ACL rules (which topic paths it can subscribe/publish to), and enables it. All LUNS calls are GraphQL POSTs to a single endpoint - the operation is selected by the GraphQL query/mutation, not by URL. ## URL pattern Every step is `POST {{uns_url}}/mqtt/gql` with header `Authorization: Bearer `. The token is obtained once per session via the LUNS OAuth2 password grant at `{{uns_url}}/auth/realms/standalone/protocol/openid-connect/token`. ## Step table | Step | Name in Collection | GraphQL operation | Input | Output / What to capture | | ------------ | ------------------ | ----------------------------------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------ | | 1 (optional) | Get Accounts | `query Account { account { ... } }` | -- | Existing accounts - avoid name collision | | 2 | Create Account | mutation `createAccount` | `{ username, password, acType: "General", enabled: false }` | Account `id` (UUID) | | 3 | Add Account Rules | mutation `addAccountRules` | `{ accountId: , rules: [{ path: "", perm: "Sub" \| "Pub" \| "PubSub" }] }` | Rules attached | | 4 | Enable Account | mutation `enableAccount` | `{ accountId: }` | Account active | | 5 (verify) | Account Details | `query account(id: ...)` | Account `id` | Final state with rules + connected clients | ## Variants - **For binding a Litmus Edge to UNS**: replace step 2 with `Create LitmusEdge Activation Token` (mutation that returns a token the LE uses during enrollment). Steps 3-5 then operate on the auto-created account once the LE connects. - **Cleanup**: `Disable Account`, `Remove Account Rules`, `Remove Account`, or `Reset Account Password` all share the same endpoint with their respective mutations. ## All LUNS endpoints Every LUNS operation (Dashboard, UNS, Security, MQTT, Integrations, Tools - 28 total) targets the same `/mqtt/gql` URL. Section grouping is purely organizational. The operation is in the GraphQL body. ## See also - [Litmus UNS product overview]() - [Security reference]() [title] Provision New Edge Device [path] Workflows/ # Provision New Edge Device (LEM Zero-Touch) **UI trigger**: LEM -> Edge Lifecycle Management -> Activation -> *Add Activation Config* -> operator boots the new device with the code -> *Approve Request*. Adds a new edge device to a LEM project. Two flows: human-approved (default) and zero-touch (devices flashed with a ZT image complete steps 2-4 automatically). All calls use `X-AuthToken: {{LEM_AdminApiToken}}`. ## Step table | Step | Name in Collection | Method | Endpoint | Body / Notes | Output | | ---- | ------------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------- | | 1 | Add Activation Config | `POST` | `{{LEM_URL}}/api/v1/activation/config` | `{ projectId, expiresAt, deviceCount, leaseTtl, licenseSkus, licenseType, ... }` | `{ code: "4JOOD-2CWAQ-..." }` | | 2 | (out-of-band) | -- | -- | Operator boots edge device with the activation code; device self-registers with LEM | Pending request appears in queue | | 3 | Requests List | `GET` | `{{LEM_URL}}/api/v1/activation/request?projectId={{project_id}}` | -- | List of pending requests with `entryID` | | 4a | Approve Request | `POST` | `{{LEM_URL}}/api/v1/activation/request/status` | `{ entryID, projectId, status: "APPROVED" }` | Device provisioned | | 4b | Reject Request (alternate) | `POST` | same endpoint | `{ entryID, projectId, status: "REJECTED" }` | Device rejected | | 4c | Retry Failed Request (if 4a errored) | `POST` | `{{LEM_URL}}/api/v1/activation/request/request-retry-provision?entryId={{project_entry_id}}&projectId={{project_id}}` | -- | Re-attempt provisioning | | 5 | Devices | `GET` | `{{LEM_URL}}/api/v1/device/{{project_id}}` | -- | New device appears in project list | ## Zero-touch variant `GET /api/v1/zt/{{project_id}}/config` (`List ZeroTouch Configs`) returns pre-configured profiles. Devices flashed with a ZT image complete steps 2-4 without operator action. [title] Create Integration Instance [path] Workflows/ # Create Integration Instance **UI trigger**: Integration -> Add Connector -> Select Provider -> Configure -> Save. The Integration module (internally `cc`) connects Litmus Edge to cloud services and databases. Creating an instance requires knowing the provider's config schema first, then supplying the correct fields in a `CreateInstance` mutation. ## Step table | Step | API Name | Method | Endpoint / GraphQL Operation | Input | Output / What to capture | | ---- | ---------------------------- | ------ | ------------------------------------------- | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | 1 | Get Provider Schema | `POST` | `{{edgeUrl}}/cc/v2` -> `GetProviderSchema` | Provider ID | Full config schema (field names, types, required, defaults, enums). See **Provider Schemas - Reference** folder. | | 2 | Create Instance | `POST` | `{{edgeUrl}}/cc/v2` -> `CreateInstance` | Provider ID + Config JSON (matching schema from step 1) | `InstanceID`, `ProviderID`, `Online`, `Status`. See **Create Instance - Provider Examples** folder. | | 3 | List Instances | `POST` | `{{edgeUrl}}/cc/v2` -> `ListInstances` | Optional filter by InstanceID | Verify instance was created, check `Online` and `Status` | | 4 | Create Subscription (topics) | `POST` | `{{edgeUrl}}/cc/v2` -> `CreateSubscription` | Instance ID + topic config | Topic subscription created - data starts flowing | ## Reference sections `api.litmus.io` includes two cross-referenced sections, one entry per provider: - **Provider Schemas - Reference** (45 entries) - canonical `GetProviderSchema` response per provider. Use as a lookup for valid config fields. - **Create Instance - Provider Examples** (45 entries) - canonical `CreateInstance` mutation per provider, with a working config body. Copy and adapt. ## Supported providers (45) AMQP (SSL/TCP), Aveva Data Hub, OSI PI Historian, AWS IoT Core/SiteWise, Azure Event Hubs/IoT Hub, Cognite, Databricks SQL, Google Cloud Pub/Sub, IBM Watson, InfluxDB (v1.7/v2), Kafka (SSL/TCP, Gen 2), Litmus UNS, MQTT (Generic/v5/SSL), MongoDB (v4+), NATS, Oracle Fusion Cloud, REST API, SQL Server, MySQL, PostgreSQL, Snowflake, Splunk. ## See also - [Integration Providers concept]() - [Integration reference]() [title] OPC UA [path] Concepts/ # OPC UA Advanced Driver OPC UA is the most common protocol customers integrate with. Litmus Edge ships with several OPC UA drivers, but **OPC UA Client Advanced** is the one to use for new integrations. ## Driver IDs | Driver name | Driver ID | When to use | | ---------------------- | -------------------------------------- | --------------------------------------------------------------------------- | | OPC UA Client Advanced | `2372E68F-BA1B-46E9-BC07-E92CA006B377` | Default for new integrations. Supports Browse, DynamicBrowse, StreamBrowse. | | OPCUA client | (legacy) | Older deployments only | | OPCUA client Poll | (legacy) | Older deployments only | The two legacy drivers exist for backwards compatibility with collections created before Advanced was available. New work should use Advanced. ## What "Advanced" gets you - **Browse**: discover the full address space of the OPC server and import nodes as tags (no manual NodeId entry). - **DynamicBrowse**: re-browse on-demand for servers whose address space changes. - **StreamBrowse**: large-server browsing without loading the whole tree at once. - **Security policies**: None / Basic128Rsa15 / Basic256 / Basic256Sha256, plus user / certificate auth. - **Subscription mode** (push from server) and **polling mode** for servers without subscriptions. ## Create a device with the Advanced driver GraphQL `CreateDevice` mutation against `/devicehub/v2`. Minimum fields: - `DriverID`: `2372E68F-BA1B-46E9-BC07-E92CA006B377` - `Name`: human label - `DeviceProperties`: server URL (`opc.tcp://host:port`), security policy, auth, etc. - exact fields come from `GetDriver` template Use `GetDriver(ID: "2372E68F-...")` to fetch the full property schema before constructing the mutation. ## Device Discovery Tool The **Device Discovery Tool** endpoint is **OPC UA Advanced only**. Point it at a server URL and it returns the server's endpoint descriptions, supported security policies, and certificates - useful before creating a device because you know exactly what security parameters the server accepts. ## Browse a device's address space Once a device exists: 1. `CreateBrowseTask` - configure the browse (root NodeId, depth, etc.) 2. `StartBrowseTasks` - run it 3. `BrowseTask_GetFoldersForTreeView`, `BrowseTask_GetFolderItems` - read results 4. `Cart_AddItems` -> `Cart_CreateAllRegisters` - turn selected nodes into tags See [Browse - Bulk Tag Discovery workflow](). ## Embedded OPC UA server (export tags out) Separate from the OPC UA *client* driver, Litmus Edge has an embedded OPC UA *server* that re-exposes DeviceHub tags to downstream OPC UA clients. APIs at `/opcua/v2`. See [Configure OPC UA Server workflow](). [title] Deploy Edge Application [path] Workflows/ # Deploy Edge Application **UI trigger**: Applications -> Marketplace -> *Launch*. ## Step table | Step | API Name | Method | Endpoint | Notes | Output | | ---- | ------------------------- | ------ | --------------------------------------------------------- | ---------------------------------------------- | ----------------------- | | 1 | List Marketplace Catalogs | `GET` | `{{edgeUrl}}/apps/marketplace/catalogs` | Check which marketplace sources are configured | Catalog list | | 2 | Get Marketplace Apps | `GET` | `{{edgeUrl}}/apps/marketplace/catalogs/{catalog_id}/apps` | Browse available apps in a catalog | App list + `appID` | | 3 | Launch a Catalog App | `POST` | `{{edgeUrl}}/apps/marketplace/launch` | Supply `appID`, config / env vars | App installed + started | | 4 | Get Running Catalog Apps | `GET` | `{{edgeUrl}}/apps/running` | Confirm app is running | Status = `running` | ## After launch App lifecycle endpoints (Applications -> Catalog Apps): - `PUT /apps/{id}/start`, `PUT /apps/{id}/stop` - `DELETE /apps/{id}` (uninstall) - `GET /apps/{id}/logs`, `GET /apps/{id}/stats` ## See also - [Applications reference]() - For the LEM-side equivalent (deploy app to many edges), see [Deploy App to Edge Device (LEM)]() [title] Configure OPC Server [path] Workflows/ # Configure OPC UA Server with Tags **UI trigger**: OPC UA -> Import Tags -> Start Server. Exposes Litmus Edge's DeviceHub tags through the embedded OPC UA server so downstream OPC UA clients can subscribe. ## Step table | Step | API Name | Method | Endpoint / GraphQL Operation | Notes | Output | | ---- | ------------------------- | ------ | --------------------------------------------------- | --------------------------------------- | ------------------ | | 1 | Get Node Root | `POST` | `{{edgeUrl}}/opcua/v2` -> `GetNodeRoot` | See current OPC UA hierarchy | Existing node tree | | 2a | Import ALL DH Tags | `POST` | `{{edgeUrl}}/opcua/v2` -> `ImportAllDHTags` | Imports every DeviceHub tag into OPC UA | Nodes created | | 2b | Import Some DH Tags | `POST` | `{{edgeUrl}}/opcua/v2` -> `ImportSomeDeviceHubTags` | Selective import by device or tag IDs | Nodes created | | 3 | Start OPC UA Service | `POST` | `{{edgeUrl}}/opcua/v2` -> `StartOPCUAService` | Starts the OPC UA server | Server running | | 4 | Get Service Configuration | `POST` | `{{edgeUrl}}/opcua/v2` -> `GetServiceConfiguration` | Verify endpoint URL, auth settings | Config object | ## Note: server vs client This workflow configures the **server** that Litmus Edge exposes (re-exporting DH tags). It is distinct from the **OPC UA Advanced client driver** used to read data **from** external OPC UA servers - that lives under DeviceHub. ## See also - [OPC UA Advanced Driver concept]() - [OPC UA reference]() [title] Create DeviceHub Device + Tags [path] Workflows/ # Create DeviceHub Device + Tags **UI trigger**: DeviceHub -> Add Device -> (configure) -> Add Tag. This is the most common chain customers struggle with. Each sub-step feeds data into the next. ## Step table | Step | API Name | Method | Endpoint / GraphQL Operation | Input | Output / What to capture | | ---- | ------------------------------- | ------ | ------------------------------------------------------------------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | 1 | List of Drivers | `POST` | `{{edgeUrl}}/devicehub/v2` -> `ListDrivers` | No input required | `DriverID`, `Name` per protocol (Modbus TCP, OPC UA, etc.) | | 2 | Get Driver Template by DriverID | `POST` | `{{edgeUrl}}/devicehub/v2` -> `GetDriver` | `{ID: ""}` | `DeviceProperties` - required fields/tabs for device config | | 3 | Create New Device | `POST` | `{{edgeUrl}}/devicehub/v2` -> `CreateDevice` | Driver ID + device properties from step 2 | `DeviceID` | | 4 | Get Driver Supported Registers | `POST` | `{{edgeUrl}}/devicehub/v2` -> `GetDriver` with `SupportedRegisters` | `{ID: ""}` | `SupportedRegisters[].Name`, `ReadOnly`, `RegisterProperties` - valid register types and value types for this driver | | 5 | Create Tag | `POST` | `{{edgeUrl}}/devicehub/v2` -> `CreateRegisters` | `DeviceID` (step 3) + register type (step 4) + tag properties | Tag ID, tag is live | ## Why step 4 is critical Each driver supports a different set of register types (e.g. Modbus TCP supports `Holding Register`, `Input Register`, `Coil`, `Discrete Input`). Calling `CreateRegisters` with an unsupported type returns a validation error. Always check `SupportedRegisters` before building the `CreateRegisters` payload. ## Optional pre-validation Use `ValidateUpdateRegisters` (GraphQL query) to dry-run a tag payload before actually calling `CreateRegisters`. The query returns `Errors[]` without committing anything. ## See also - [DeviceHub Data Model]() - [Browse - Bulk Tag Discovery]() for auto-discovering tags instead of creating them manually - [DeviceHub reference]() [title] Upload AI/ML Model to LEM [path] Workflows/ # Upload AI/ML Model to LEM **UI trigger**: LEM -> Edge Lifecycle Management -> AI/ML Models -> *Upload New Model*. :::BlockQuote LEM uses a **pre-signed S3 URL** pattern instead of the LE resumable-session pattern. Step 1 gets a signed URL; Step 2 uploads directly to object storage; Step 3 registers the model in LEM. ::: ## Step table | Step | Name in Collection | Method | Endpoint | Body / Notes | Output | | ---- | -------------------------------- | ------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------- | ---------------------------- | | 1 | Step 1 of Upload New AI/ML Model | `POST` | `{{LEM_URL}}/api/v1/file/{{project_id}}/mlModel/{{filename}}/upload-url` | `{"projectId": "...", "fileName": "model.zip"}` | `{"url": ""}` | | 2 | Step 2 of Upload New AI/ML Model | `PUT` | `` | Binary `.zip` model file bytes. URL carries AWS SigV4 query params. | 200 OK (S3 direct upload) | | 3 | Step 3 of Upload New Model | `POST` | `{{LEM_URL}}/api/v1/file/{{project_id}}/mlModel/{{filename}}` | `{"description": "..."}` - registers the model in LEM | Model available in LEM | ## Auth notes - Steps 1 and 3 use `X-AuthToken: {{LEM_AdminApiToken}}`. - Step 2 (S3 PUT) uses the embedded AWS SigV4 signature in the URL - **no additional auth header needed**. Sending `X-AuthToken` to S3 will fail. [title] System [path] API Reference/ # System / Device Management (LE) REST under `/dm/...` (Device Management) and `/auth/v3/...` (Auth). Configure the host edge device itself: network, certificates, users, backups, templates, time, factory reset. :::BlockQuote **Run these endpoints:** open the [System folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#0f5be06c-21b9-4d3b-9302-f9dc6b0f3d97). ::: ## Sub-areas | Area | Path | Purpose | | ------------- | ------------------- | ------------------------------------------- | | Auth | `/auth/v3/...` | OAuth2 token, user / client management | | Templates | `/dm/template/v2` | Export / apply configuration templates | | Backup | `/dm/backup/v2` | Backup the edge config, restore from backup | | Certificates | `/dm/certstore` | Custom CA upload | | Network | `/dm/network/...` | Interfaces, routes, DNS, hostname | | Time | `/dm/time/...` | NTP config | | Users | `/dm/users/...` | Local users (distinct from API clients) | | Licensing | `/licensing/...` | License info | | Factory reset | `/dm/factory-reset` | Wipe and reinitialize | ## Resumable uploads Templates, backups, certificates, and analytics models all use the [3-step resumable upload pattern](). ## Related workflows - [Apply / Upload Template]() - [Restore Backup]() - [Upload Custom CA Certificate]() [title] API Reference [path] / # API Reference Per-module endpoint inventory. Each page in this section lists the endpoints in one product module with a one-line purpose. :::BlockQuote **Endpoint schemas live on api.litmus.io.** Each service page below summarises what's available; for the full request/response schema and a runnable example, click through to the [interactive API collection](https://api.litmus.io/view/2s9Y5R1RvG). ::: ## Where the detailed schema lives These pages give the **section-level orientation** - what's in this module, how the endpoints relate, what the auth / URL pattern is. Full per-endpoint request / response schema is served by the visual API portal: | Surface | Use for | | ---------------------- | -------------------------------------------------------------------------------------------------------- | | `api.litmus.io` | Per-endpoint request body, response shape, try-it-out, code samples in cURL / Python / Go / Node / Shell | | `api.litmus.io/agents` | Agent-readable endpoint catalog for LLMs and automation | When you find an endpoint here by name, follow the section link to the corresponding page on `api.litmus.io` for the schema and to test the call. ## How to use this section - Looking for **one endpoint** by name or purpose? Use the per-module pages here, then jump to `api.litmus.io`. - Building a **multi-step flow** (chain several endpoints together)? Go to [Workflows]() instead. - New to a product? Start with [Products]() for the high-level map. ## Layout - [Litmus Edge]() - 9 modules: Dashboard, DeviceHub, Digital Twins, DataHub, Flows Manager, Analytics, Applications, Integration, OPC UA, System - [Litmus Edge Manager]() - 3 modules: Companies, Edge Lifecycle, Digital Twins - [Litmus UNS]() - 5 modules, all GraphQL on `/mqtt/gql`: Dashboard, UNS, Security, MQTT, Integrations [title] DataHub [path] API Reference/ # DataHub (LE) 16 endpoints. REST under `/datahub/...`. Internal data routing and storage configuration - controls where DeviceHub tag values are persisted and which retention applies. :::BlockQuote **Run these endpoints:** open the [DataHub folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#eadfdbe0-2550-47ff-bbfb-168a3155ebb0). ::: ## Capabilities - Configure / inspect the embedded time-series store - Manage cloud storage targets (S3 / Azure Blob / GCS) for tag-data offload - Set retention policies - Trigger / monitor batch exports ## Typical operations | Endpoint | Purpose | | ------------------------------------- | --------------------------- | | `GET /datahub/config` | Current data routing config | | `PUT /datahub/config` | Update config | | `GET /datahub/cloud-storages` | List cloud storage targets | | `POST /datahub/cloud-storages` | Add a cloud storage target | | `PUT /datahub/cloud-storages/{id}` | Update | | `DELETE /datahub/cloud-storages/{id}` | Remove | | `GET /datahub/retention` | Retention policy | | `PUT /datahub/retention` | Update retention | :::BlockQuote DataHub is distinct from **Integration** (`/cc/v2`). DataHub stores edge-local; Integration streams out to external systems. ::: [title] Dashboard [path] API Reference/ # Dashboard (LE) 22 read-only endpoints for liveness, utilization, and counts. Useful for status pages and external monitors. :::BlockQuote **Run these endpoints:** open the [Dashboard folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#4566254a-0d6a-473f-ae60-5b3fb7ebc83c). ::: ## Module status (GET) | Endpoint | Returns | | ----------------------- | --------------------------------- | | `GET /devicehub/status` | DeviceHub health | | `GET /flows/status` | Flows Manager health | | `GET /analytics/status` | Analytics health | | `GET /apps/status` | Marketplace / Applications health | | `GET /cc/status` | Integrations health | | `GET /opcua/status` | Embedded OPC UA server health | | `GET /dm/status` | Device Management health | | `GET /licensing/status` | Licensing | ## Host info and utilization (GET) | Endpoint | Returns | | ----------------------------- | ---------------------------------------- | | `GET /dm/host` | Host device info (hardware, OS, version) | | `GET /dm/storage` | Device storage utilization | | `GET /dm/network/last_minute` | Network utilization, last 1 min | | `GET /dm/memory/last_minute` | Memory utilization, last 1 min | | `GET /dm/cpu/last_minute` | CPU utilization, last 1 min | ## Inventory counts (mixed) | Endpoint | Method | Returns | | -------------------------------- | ------ | ------------------------------ | | `/devicehub/v2` (`ListDevices`) | POST | List of configured devices | | `/devicehub/v2` (`NumberOfTags`) | POST | Total tag count | | `/analytics/processors/count` | GET | Number of Analytics Processors | | `/analytics/groups/count` | GET | Number of Analytics Groups | | `/flows/count` | GET | Number of Flows | | `/cc/count` | GET | Number of Integrations | | `/datahub/cloud-storages/count` | GET | Number of Cloud Storages | | `/apps/count` | GET | Number of Edge Applications | | `/auth/v3/online-users` | GET | Active online users | :::BlockQuote All endpoints listed are read-only. Suitable for a frequent (every 30-60s) polling cadence. ::: [title] Marketplace/Applications [path] API Reference/ # Applications (LE) 69 endpoints. REST under `/apps/...`. Manage edge applications - the containerized add-ons (Grafana, custom apps, vendor tools) that run alongside Litmus Edge. :::BlockQuote **Run these endpoints:** open the [Applications folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#d7a1c21b-0d44-4601-bd97-9d50ec5ed1b6). ::: ## Capabilities - Browse the Marketplace catalog - Launch an app from the catalog - Manage running apps (start, stop, restart, uninstall) - Pass config / env vars at launch - Inspect logs and resource usage ## Sub-areas | Folder | Purpose | | ------------ | ------------------------------------------------------ | | Marketplace | Catalog browsing - sources, catalogs, available apps | | Catalog Apps | Lifecycle of installed apps from the catalog | | Local Apps | Side-loaded apps (uploaded directly, not from catalog) | | Logs / Stats | Per-app diagnostics | ## Typical operations | Endpoint | Purpose | | --------------------------------------------- | ----------------------------------------------- | | `GET /apps/marketplace/catalogs` | List marketplace sources | | `GET /apps/marketplace/catalogs/{id}/apps` | Apps available in a catalog | | `POST /apps/marketplace/launch` | Launch a catalog app (body: appID, env, config) | | `GET /apps/running` | Currently running apps | | `PUT /apps/{id}/start`, `PUT /apps/{id}/stop` | Lifecycle | | `DELETE /apps/{id}` | Uninstall | | `GET /apps/{id}/logs` | Recent logs | | `GET /apps/{id}/stats` | CPU / memory | See [Deploy Edge Application workflow](). [title] Backup and Restore [path] Workflows/ # Backup and Restore an Edge Device from LEM **UI trigger**: LEM -> Edge Lifecycle Management -> Edge Devices -> select device -> Backups -> *Make Backup* / *Restore*. Backups are stored in LEM-managed S3 and accessed via pre-signed URLs (no further auth needed on the URL itself). The backup target on restore can be a different device than the source, which enables configuration cloning across devices. ## Step table | Step | Name in Collection | Method | Endpoint | Body / Notes | Output | | -------------------------- | -------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | ----------------------------------------------------------- | | 1 | Make Device Backup | `POST` | `{{LEM_URL}}/api/v1/backup/init-backup?projectId={{project_id}}&deviceId={{edge_device_id}}` | No body. Asynchronous - backup runs on the device. | `{ "code": "200", "content": null }` | | 2 | List Backups | `GET` | `{{LEM_URL}}/api/v1/backup/list?projectId={{project_id}}&deviceId={{edge_device_id}}` | Poll until the new entry appears | List with `timestamp` and `backupType` (typically `MASTER`) | | 3 | Get Pre-signed S3 URL to Backup | `POST` | `{{LEM_URL}}/api/v1/backup/get?projectId={{project_id}}&deviceId={{edge_device_id}}&backupType=MASTER×tamp={ts}` | -- | Pre-signed S3 GET URL valid 7 days | | 4 (optional, cross-tenant) | Save Backup to Pre-signed S3 URL | `POST` | `{{LEM_URL}}/api/v1/backup/put?...` | Used only when relocating the `.dat` to a different S3 location | New pre-signed PUT URL | | 5 | Restore from Backup | `POST` | `{{LEM_URL}}/api/v1/backup/init-restore?projectId={{project_id}}&deviceId={{target_edge_device_id}}&backupType=MASTER×tamp={ts}` | `deviceId` query param can target a **different** device than the source | Restore initiated on target device | ## Distinct from "LEM Backup" This chain backs up a **single edge device** (`/api/v1/backup/...`). To back up the LEM instance itself, use Admin Console -> Admin Console Settings -> Backup (`/admin/v1/lem-backup/...`). ## Auth All calls use `X-AuthToken: {{LEM_AdminApiToken}}`. The pre-signed S3 URL from step 3 carries SigV4 query params and needs **no** auth header. [title] Deploy App to Edge Device [path] Workflows/ # Deploy Application to Edge Device (LEM Async-Task) **UI trigger**: LEM -> Edge Lifecycle Management -> Applications -> *Launch Application*. LEM long-running operations (app launch, ML deploy, software update) are wrapped in an async-task envelope. The client POSTs a task description, gets a `taskId`, and polls subtask status until `SUCCESS`. The same pattern underlies several LEM ops. ## Step table | Step | Name in Collection | Method | Endpoint | Body / Notes | Output | | ---- | ---------------------------------------- | ------ | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | 1 | Catalogs | `GET` | `{{LEM_URL}}/mpcs/catalogs` | Header: `Authorization: {{LEM_AdminApiToken}}` (NOT `X-AuthToken`) | `catalogId` | | 2 | Catalog Applications | `GET` | `{{LEM_URL}}/mpcs/catalogs/{catalogId}/applications` | Same `Authorization` header | `applicationId`, `applicationName`, `applicationVersion` | | 3 | Launch Application to Edge Device | `POST` | `{{LEM_URL}}/api/v1/async-task/task-with-subtasks` | Header: `X-AuthToken: {{LEM_AdminApiToken}}`. Body: see below. | `{ taskId }` | | 4 | Verify If Deploy Task is Complete (poll) | `GET` | `{{LEM_URL}}/api/v1/async-task/{{task_id}}/subtasks` | Poll until each subtask `status == "SUCCESS"`. Other states: `PENDING`, `IN_PROGRESS`, `FAILED` | Subtask list with status | | 5 | Apps List for Device | `GET` | `{{LEM_URL}}/api/v1/marketplace/app/plain?...` | -- | Confirm app installed on device | ## Step 3 body ```json { "name": "", "companyName": "...", "projectId": "...", "type": "MARKETPLACE_APPLICATION_LAUNCH", "subtasks": [{ "deviceId": "...", "type": "MARKETPLACE_APPLICATION_LAUNCH", "params": { "applicationId": "...", "applicationName": "...", "applicationVersion": "...", "catalogId": "...", "catalogName": "...", "catalogUrl": "...", "applicationParameters": { ... } } }] } ``` ## Same async-task wrapper is used by - ML model deploy (`type: "ANALYTICS_ML_MODEL_UPLOAD"`) - Software updates (`type: "FIRMWARE_UPDATE"`) - Other long-running fleet ops `Software Update History` endpoint at `/api/v1/async-task/subtasks` reads recent runs across all task types. ## Auth nuance - Steps 1 and 2 hit `/mpcs/` and require `Authorization: {{LEM_AdminApiToken}}` (no `Bearer` prefix). - Steps 3-5 hit `/api/v1/` and require `X-AuthToken: {{LEM_AdminApiToken}}`. - Sending the wrong header returns 401. [title] API Portal FAQs [path] / ## API Portal FAQs ## Who can access the API Portal? The API Portal is available to all customers on the **Scale** plan. Other plan tiers can request access through their account team. ## What's the difference between docs.litmus.io/api-docs and api.litmus.io? They're two complementary surfaces. - **docs.litmus.io/api-docs (this site)** is the narrative documentation: concepts, getting-started, walkthroughs, error model, and per-service reference summaries. Best when you want to understand *what* an API does and *how* it fits. - [api.litmus.io](https://api.litmus.io) is the executable Postman collection: 1,944 endpoints across Litmus Edge, Edge Manager, and Unify. Best when you want to *run* an endpoint, fork the collection into your own workspace, or generate request code in cURL, Python, or JavaScript. api.litmus.io also exposes AI-agent surfaces, an MCP manifest, a Python SDK reference, and `llms.txt`, none of which live here. ## Are deprecated APIs listed here? The portal is an exhaustive list of APIs that are actively managed by the Litmus team. APIs not listed here are not supported and may be deprecated. See [Deprecation Policy](). ## What can I customize about the portal? - **Code samples**: use the language dropdown to switch between Python, cURL, Go, Node.js, Shell, HTTP, and others. - **Postman**: use the export option to import the full collection into Postman. - **Theme**: toggle between light and dark. - **Layout**: single-column vs multi-column. ## I see a blank screen or data fetch error - what do I do? 1. Refresh the page. 2. Try an incognito / private window (rules out a stale cache or extension). 3. If the issue persists, contact `support@litmus.io` with the exact URL and a screenshot. ## I'm getting SSL certificate errors - what do I do? Litmus Edge ships with a self-signed certificate. Until you install your own CA, clients reject the connection. Quick fixes: | Tool | Flag | | ----------------- | --------------------------------------------------------- | | cURL | `-k` or `--insecure` | | Python `requests` | `verify=False` | | Postman | Settings -> General -> "SSL certificate verification" off | Example: ```bash curl -k "https:///devicehub/version" -H "Authorization: Bearer $TOKEN" ``` **Do not use these workarounds in production.** Instead, install a CA-signed certificate via [Upload Custom CA Certificate](), or trust the edge's self-signed cert on your client. See [SSL Certificates](). ## Where do I get OAuth credentials? | Product | Where | | ----------- | ------------------------------------------------- | | Litmus Edge | System -> Settings -> Users -> API Clients | | LEM | Admin Console -> API Tokens | | LUNS | Admin -> Users (use the configured Keycloak user) | ## What's the difference between LE Integration and LUNS Integration? - **LE Integration** (`/cc/v2`): routes per-tag data from a single edge out to 45 supported providers (cloud queues, TSDBs, RDBMS). - **LUNS Integration**: bridges the entire UNS namespace to another MQTT-like broker. Both can coexist - LE Integration would typically be the path data takes to LUNS, then LUNS Integration bridges further out. ## How do I contact support? Email `support@litmus.io` or open a ticket via the Litmus support portal. [title] Integration [path] API Reference/ # Integration (LE) 112 endpoints in 4.0.x. GraphQL on `/cc/v2` (internal name "cc" = connector cloud). Route DeviceHub data to 45 external systems: cloud queues, time-series DBs, SQL databases, MQTT brokers, REST APIs. :::BlockQuote **Run these endpoints:** open the [Integration folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#df55ef1d-7dd6-402a-9bbe-12d5272e485d). ::: ## Sub-areas | Folder | Endpoints | Purpose | | ----------------------------------- | --------- | ----------------------------------------------------- | | Instances | \~6 | Instance CRUD + lifecycle | | Subscriptions | \~6 | Topic / table-route config per instance | | Streaming | \~8 | Streaming-style provider ops | | Object | \~3 | Object-store-style providers | | Prometheus | \~1 | Prometheus scrape source | | Create Instance - Provider Examples | 45 | One canonical CreateInstance per provider | | Provider Schemas - Reference | 45 | One canonical GetProviderSchema response per provider | ## Core operations | Operation | Purpose | | --------------------------------------------------------------- | -------------------------------------- | | `ListProviders` | What integrations are supported | | `GetProviderSchema(ProviderID)` | Config field schema for a provider | | `CreateInstance(ProviderID, Config)` | Create a configured instance | | `UpdateInstance`, `DeleteInstance` | Manage | | `ListInstances` | All configured instances | | `StartInstance`, `StopInstance` | Lifecycle | | `CreateSubscription` | Route topics / tables into an instance | | `ListSubscriptions`, `UpdateSubscription`, `DeleteSubscription` | Manage subscriptions | ## The 45 providers See [Integration Providers concept page]() for the full list. Cloud queues (AWS IoT, Azure Event Hubs, Kafka, MQTT), TSDBs (InfluxDB, OSI PI, Snowflake), RDBMS (Postgres, MySQL, SQL Server, Oracle), and generic outbound (REST API, Litmus UNS). ## See also - [Integration Providers concept]() - [Create Integration Instance workflow]() [title] OPC UA [path] API Reference/ # OPC UA (LE) 27 endpoints. GraphQL on `/opcua/v2`. Manages the **embedded OPC UA server** that re-exposes DeviceHub tags to downstream OPC UA clients. :::BlockQuote **Run these endpoints:** open the [OPC UA folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#6bb95043-4e3d-458e-8088-9fb008a8ead3). ::: :::BlockQuote This is **distinct from the OPC UA Advanced client driver** (used to read from external OPC UA servers). The client driver lives under DeviceHub. The server lives here. ::: ## Sub-areas | Folder | Purpose | | ----------- | -------------------------------------------------------------------- | | Hierarchy | Browse and edit the OPC UA address space the embedded server exposes | | Management | Service config, endpoints, certificates, users | | Connections | Currently connected OPC UA clients | ## Typical operations ### Hierarchy | Operation | Purpose | | ------------------------- | ------------------------------------------------- | | `GetNodeRoot` | Read the root of the namespace | | `GetNodes(ParentID)` | Children of a node | | `CreateNode` | Add a node (folder or variable) | | `DeleteNode` | Remove | | `ImportAllDHTags` | Bulk-import every DeviceHub tag as an OPC UA node | | `ImportSomeDeviceHubTags` | Selective import (by device or tag IDs) | | `ClearAllNodes` | Wipe the address space | ### Management | Operation | Purpose | | ----------------------------------------- | ------------------------------------------------- | | `GetServiceConfiguration` | Endpoint URL, security policies, anonymous toggle | | `UpdateServiceConfiguration` | Edit | | `StartOPCUAService`, `StopOPCUAService` | Lifecycle | | `ListUsers`, `CreateUser`, `DeleteUser` | Server users (for username/password auth) | | `GetCertificate`, `RegenerateCertificate` | Server cert | ### Connections | Operation | Purpose | | ------------------ | ------------------------------ | | `ListConnections` | Currently connected clients | | `DisconnectClient` | Force-disconnect by session ID | See [Configure OPC UA Server workflow](). [title] Support and Contact [path] Operations/ # Support and Contact ## Email - General support: `support@litmus.io` - Sales engineering / customer success: contact your account team ## Support portal Open a ticket via the Litmus support portal (URL provided to customers on plan onboarding). ## What to include in a support ticket For API issues, please include: - Product and version (LE 4.0.x, LEM 2.31.x, etc.) - Endpoint method + URL - Request body (redact secrets) - Response status and body - A correlation / request ID if returned ## Plan availability The API Portal is available to customers on the **Scale** plan. Other plan tiers can request access through their account team. [title] DeviceHub [path] API Reference/ # DeviceHub (LE) 342 endpoints in 4.0.x. The bulk of Litmus Edge - device configuration, tag creation, browse, asset discovery, plus 292 reference entries (driver examples + register types). :::BlockQuote **Run these endpoints:** open the [DeviceHub folder on api.litmus.io](https://api.litmus.io/view/2s9Y5R1RvG#3384d3cf-13e6-402b-8a25-b67be34f585d). ::: ## Sub-modules | Folder | Endpoints | Purpose | | --------------------------------- | --------- | ----------------------------------------- | | Devices | 10 | Device CRUD + lifecycle (start/stop) | | Drivers | 4 | List drivers, get driver templates | | Tags | 12 | Tag CRUD + CSV import/export + validation | | Browse | 14 | Bulk tag discovery from a device | | Asset Discovery | 9 | Network-level asset scanning | | Prometheus Metrics | 1 | Metrics scrape endpoint | | Create Device - Driver Examples | 146 | One canonical CreateDevice per driver | | Register Types - Driver Reference | 146 | Supported register types per driver | ## Devices (10) GraphQL on `/devicehub/v2` unless noted. | Operation | Method | Purpose | | ---------------------------------- | ------ | ------------------------------------ | | `ListDevices` | POST | List all configured devices | | `CreateDevice` | POST | Create a new device | | `UpdateDevice` | POST | Update device properties | | Enable/Disable Device Data Storage | PUT | Toggle persistence per device (REST) | | `DeleteDevices` | POST | Delete one or more devices (GraphQL) | | Delete Device REST | DELETE | Single-device delete via REST | | Device Discovery Tool | POST | OPC UA Advanced server discovery | | `DeviceConnectionStatus` | POST | Live connection state | | `StartDevice` | POST | Begin polling | | `StopDevice` | POST | Stop polling | ## Drivers (4) | Operation | Purpose | | ----------------------- | ---------------------------------------------- | | `ListDriverGroups` | Driver family tree (start here) | | `GetDriver` by GroupID | Group-level template | | `GetDriver` by DriverID | Driver template (config + supported registers) | | List all driver details | Full dump of all drivers | ## Tags (12) | Operation | Purpose | | --------------------------- | --------------------------------- | | `ListAllRegisters` | All tags across all devices | | `ListRegisters` | Tags on one device | | `CreateRegisters` | Create one or more tags | | `UpdateRegisters` | Update tag config | | `DeleteRegisters` | Delete specific tags | | Delete all tags of a device | Bulk-delete by device | | `BrowseTags` | Search across configured tags | | Upload Tags CSV | REST file upload | | Download Tags CSV | REST file download | | `RegisterStatus` | Live tag values + quality | | Server Search | Cross-device tag search | | `ValidateUpdateRegisters` | Dry-run a tag payload (no commit) | ## Browse (14) Full chain documented in [Browse - Bulk Tag Discovery workflow](). Key operations: - `CreateBrowseTask`, `StartBrowseTasks`, `ListBrowseTasks`, `StopBrowseTask`, `DeleteBrowseTask` - `BrowseTask_GetFoldersForTreeView`, `BrowseTask_GetFolderItems` - `Cart_AddItems`, `Cart_UpdateProperties`, `Cart_CreateAllRegisters` - `ListCartItems`, `Cart_GetCartItemsByDevice` - `BrowseTask_GetTemplate`, `Download Browse Tags` (CSV export) ## Asset Discovery (9) Network-level scanning per interface. All REST. | Endpoint | Purpose | | ----------------------------------------------- | ----------------------------- | | `GET /devicehub/assetdiscovery/interfaces` | List network interfaces | | `GET /devicehub/assetdiscovery/devices` | Discovered devices on network | | `GET .../scan/eth0`, `GET .../scan/wlan0` | Trigger per-interface scan | | `PUT .../enable/eth0`, `PUT .../disable/eth0` | Toggle discovery on eth0 | | `PUT .../enable/wlan0`, `PUT .../disable/wlan0` | Toggle discovery on wlan0 | | `GET .../scan/nd` | Scan for ND nodes | ## Create Device - Driver Examples (146) One canonical `CreateDevice` mutation per supported driver - Allen-Bradley, Siemens, Modbus variants, OPC UA, MQTT, SQL clients, Sparkplug, plus simulators (Generator). Use as a copy-and-adapt reference. ## Register Types - Driver Reference (146) For each driver, the supported register types (e.g. Modbus TCP: Holding / Input / Coil / Discrete Input). Use to validate that the register type you want is allowed before calling `CreateRegisters`. ## See also - [DeviceHub Data Model]() - [Create Device + Tags workflow]() [title] Restore Backup (LE) [path] Workflows/ # Restore Backup (LE) **UI trigger**: System -> Device Management -> Backup/Restore -> *Apply Backup*. ## Step table | Step | Name in Collection | Method | Endpoint | Body / Notes | Output | | ---- | --------------------------------------------- | -------- | -------------------------------------- | ------------------------------- | ------------------------ | | 0 | Step 0: Apply Backup - Delete Upload Sessions | `DELETE` | `{{edgeUrl}}/dm/backup/v2` | No body. Clears stale sessions. | 200 OK | | 1 | Step 1: Apply Backup - Create Upload Session | `POST` | `{{edgeUrl}}/dm/backup/v2` | `{"size": }` | `{"id": ""}` | | 2 | Step 2: Apply Backup - Resume/Apply Backup | `PUT` | `{{edgeUrl}}/dm/backup/v2/{id}/resume` | Binary backup file bytes | 200 OK, device restores | :::BlockQuote The edge restarts services as part of restore. Subsequent calls may briefly 502 / 503 until services come back. ::: ## See also - [Resumable Uploads concept]() - For LEM-side device backup, see [Backup and Restore from LEM]() [title] Apply / Upload Template (LE) [path] Workflows/ # Apply / Upload Template (LE) **UI trigger**: System -> Device Management -> Templates -> *Apply Template* (downloads a `.zip`, then re-uploads it). :::BlockQuote What the UI does invisibly: when a user clicks "Download Template", the UI first clears any previous upload session, then creates a new one, then uploads the file - the user just sees a file download/upload dialog. ::: ## Step table | Step | Name in Collection | Method | Endpoint | Body / Notes | Output | | ---- | ---------------------- | -------- | ---------------------------------------- | ----------------------------------------- | ------------------------ | | 0 | Step 0: Apply Template | `DELETE` | `{{edgeUrl}}/dm/template/v2` | No body. Clears any stale upload session. | 200 OK | | 1 | Step 1: Apply Template | `POST` | `{{edgeUrl}}/dm/template/v2` | `{"size": }` | `{"id": ""}` | | 2 | Step 2: Apply Template | `PUT` | `{{edgeUrl}}/dm/template/v2/{id}/resume` | Binary file bytes in body | 200 OK, template applied | ## Related: download a template To export a template (before applying it elsewhere): | Name | Method | Endpoint | Notes | | ----------------- | ------ | ------------------------- | ------------------------------------------------------------------ | | Download Template | `POST` | `{{edgeUrl}}/dm/template` | Body: JSON with device IDs and flags to include/exclude components | ## See also - [Resumable Uploads concept]() - [System / Device Management reference]() [title] Deprecation Policy [path] Operations/ # Deprecation Policy ## What's documented vs what's supported The API portal is the canonical list of **actively-supported** APIs. If an endpoint is not in the portal, treat it as unsupported - it may exist in older builds but is not guaranteed to keep working. ## Deprecation timeline - Deprecation notice is posted before removal, typically 6 months in advance. - Deprecated endpoints continue to function during the notice period. - After removal, calls return 410 Gone or 404 Not Found depending on the module. ## Recommendation - Pin to a specific product / API version in your client. - Subscribe to release notes for the products you depend on. - For automation that runs unattended, set up a smoke test that exercises your critical endpoints against new edge / LEM releases before rolling them out. [space] Litmus Edge Manager (/edgemanager) [title] Step 5: Verify Edge Device Activation in Litmus Edge [path] QuickStart Guide/Activate an Edge Device/ After you have approved the activation request in Litmus Edge Manager, return to Litmus Edge to verify the activation was successful. **To verify the activation was successful:** 1. From the Litmus Edge navigation panel, select **System** > **Tokens**. 2. From *REST API Key*s, verify the creation of a **System API key (read only)**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/rmE4IMx9F-XzjtIuYZdkS_system-api-token.png" size="80" width="1920" height="866" position="center" caption="System API key (read only)" showCaption="true"} 3. From the navigation panel, select **System** > **Certificates > Identity**. 4. From *Identity Certificates*, verify the creation of an **Identity Certificate **issued by *Litmus Edge Manager.* # Next Step The next step is [Enable Default Generic MQTT SSL Connector in Litmus Edge.](docId\:J7vZy8dJzBQGu0WjEyzIa) [title] Step 6: Enable Default Generic MQTT SSL Connector in Litmus Edge [path] QuickStart Guide/Activate an Edge Device/ In Litmus Edge, you will next enable the default generic MQTT SSL connector to facilitate a data connection between the Litmus Edge instance and its respective Litmus Edge Manager. **To enable the connector: ** 1. From the navigation panel, select **Integration**. 2. From the **Default Generic MQTT SSL connector **tile's top-right corner, click the connector toggle switch. 3. Wait a few seconds for the **Default Generic MQTT SSL connector **tile's top-left corner to show a `CONNECTED` status. See the *Manage Individual Connectors* section in [Manage Connectors](docId:5hctoRLhgaX3Ikh_lvi0A) for more information. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/AGu7ox7E-LN_9ZrRab6Kx_2023-07-1714-36-27.png "Enabling Default Generic MQTT SSL connector") # Next Step Lastly, [verify Edge Device activation in Litmus Edge Manager](docId\:KC9sqRSng2KSINWL1PfPi). [title] Policy [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ The *Policy* tab allows you to view the current policies set up for the selected edge device. You can select a different policy from the Selected Policy drop-down list and save it for the edge device. The policies are set up in the Admin console and the available policies appear on the list. To update the password policy, select one from the drop-down list. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/4DUypC16vZfE4XrW1-hY2_5lrrehno1-vgcpayjo7lpimage.png "Policy tab") New policies can be generated from Litmus Edge Manager Admin Console's [Edge Password Policies](docId\:nZxdm63Ip1guJ_mQiN140) pane. [title] Deployment of Litmus Edge Manager from Azure SaaS [path] QuickStart Guide/Installation and Deployments/ Litmus provides Litmus Edge Manager (LEM) as a managed SaaS solution on Azure Marketplace. If your organization has a custom agreement, you use a private offer for deployment. A private offer is custom plan that you've negotiated with Litmus that is not available on the public marketplace. You deploy LEM through the private offer by: - Accepting the private offer on the Azure marketplace - Purchasing and deploying the private on the Azure marketplace - Activating the subscription on Litmus Central Portal - Downloading and deploying Litmus Edge Manager from Litmus Central Portal Note that private plans are offered through Site Model licensing. This licensing model gives you full control over your infrastructure. With this model: - You deploy the infrastructure but no license is included. You request a license separately from the Litmus Account team. - Tag consumption is not monitored or billed. - You maintain full control over your virtual machines. Litmus has no access to your environment. ## Prerequisites Before you being, ensure that you have: - Negotiated a private plan with Litmus. - Access to [Azure Portal](https://portal.azure.com/). # Step 1: Accept the Private Offer 1. Log in to [Azure Portal](https://portal.azure.com/#home) and search for `Marketplace`. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/9kr-Sl91f0MOVHMpZDw5x_image.png" size="80" width="1568" height="628" position="flex-start" darkWidth="1568" darkHeight="628" showCaption="false" indent="2"} 2. In the left navigation menu, select **Private Offer Management**. 3. In the **Private Offer Management** page, click **View + accept** for the **Litmus Edge Manager SaaS - Site Model** offer. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Gd5X6gYFcUV6RP1vUKf8w_image.png" size="80" width="1497" height="497" position="flex-start" darkWidth="1497" darkHeight="497" showCaption="false" indent="2"} 4. Next, a page displays with offer details and terms and conditions. Review this information, confirm that you've read the terms and conditions, and click **Accept Private Offer**. Then you're returned to the **Private Offer Management** page. # Step 2: Purchase and Deploy the Private Offer 1. In the **Private Offer Management** page, click **Purchase** for the Litmus Edge Manager SaaS - Site Model offer. 2. In the right pane, define the following settings: - **Resource Group**: Select a resource group in which to place the SaaS instance. - **Name**: Provide a name for the Litmus Edge Manager SaaS offering that you're subscribing to. - **Billing term**: Select a 1, 2, or 3 year subscription. - **Recurring billing**: Decide on whether to automatically renew after the subscription expires. 3. Click **Review + subscribe**, review subscription settings again if necessary and click **Subscribe**. The **Subscription progress** page displays while the SaaS subscription is setting up. When complete, the offering has been deployed. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ZrWpnogY9zU7_dLx4oDvl_image.png" size="80" width="1500" height="649" position="flex-start" darkWidth="1500" darkHeight="649" showCaption="false" indent="2"} 4. Once complete, click **Configure account now** and you are directly to the Azure Marketplace Activation page in [Litmus Central Portal](https://portal.litmus.io/). The link redirects you to the **Azure Marketplace Activation** page in Central Portal. # Step 3: Activate the Subscription in Litmus Central Portal 1. On the **Azure Marketplace Activation** page in Central Portal, click **Activate Subscription**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Cr0n0RYjB7Hbdx7qhNOFN_image.png" size="80" width="1480" height="737" position="flex-start" darkWidth="1480" darkHeight="737" showCaption="false" indent="2"} :::Paragraph{indent="2"} A message displays indicating that Microsoft is finalizing the activation. ::: 2. When complete, click **Deploy to Azure**. You also receive an email from Microsoft confirming that the SaaS subscription is active. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/x61MYfhCdqcoFQOkp8Zus_image.png" size="80" width="1335" height="801" position="flex-start" darkWidth="1335" darkHeight="801" showCaption="false" indent="2"} # Step 4: Deploying to Azure In the **Custom deployment** page in Azure, specify template settings for the deployment. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/8r2YoDbR0EBFAoGc-uP31_image.png" size="80" width="1330" height="673" position="flex-start" darkWidth="1330" darkHeight="673" showCaption="false"} ### Required Parameters | Parameter | Description | | ------------ | ------------------------------------------- | | sshPublicKey | SSH public key for VM administrator account | ### VM Configuration | Parameter | Description | Default value | | ------------- | ------------------------------------------------------ | ----------------------- | | projectName | Name prefix for generating resource names (3-10 chars) | lem | | location | Azure region for deployment | Resource group location | | vmSize | VM size (minimum recommended: Standard\_B4ms) | Standard\_B4ms | | adminUsername | VM administrator username | lemadmin | | osDiskSizeGB | OS disk size in GB (128-1024) | 160 | ### Network Configuration In the downloaded template, you can modify the `subnetAddressPrefix` or use it as is. For example, modify the parameter to accept a /32 single IP. | Parameter | Description | Default value | | --------------------------- | ------------------------------- | ------------- | | virtualNetworkNewOrExisting | Create new or use existing VNet | new | | virtualNetworkName | Name of virtual network | lem-vnet | | virtualNetworkResourceGroup | Resource group of existing VNet | Current RG | | virtualNetworkAddressPrefix | Address prefix for new VNet | 10.0.0.0 | | subnetName | Name of subnet | lem-subnet | | subnetAddressPrefix | Address prefix for new subnet | 10.0.0.0/24 | ### Public IP Configuration Litmus Edge Manager does not require a public IP. It only needs to be reachable from the Litmus Edge instances that connect to it and Litmus Edge Manager users. Where reachability is provided privately (VNet peering, VPN, or ExpressRoute) set `publicipneworexistingornone` to `none`. | Parameter | Description | Default value | | --------------------------- | ------------------------------------------------ | ------------- | | publicIpNewOrExistingOrNone | Create new, use existing, or none (private only) | new | | publicIpName | Name of public IP address | lem-pip | | publicIpResourceGroup | Resource group of existing public IP | Current RG | ### Tags Enter tags in the parameter field as JSON using the following syntax. `{"environment": "production", "costCenter": "IT-12345", "owner": "admin@company.com"}` | Parameter | Description | | ------------------------ | ---------------------------- | | vmTags | Tags for the virtual machine | | networkSecurityGroupTags | Tags for the NSG | | virtualNetworkTags | Tags for the VNet | | publicIpTags | Tags for the public IP | | networkInterfaceTags | Tags for the NIC | # Step 5: Accessing Litmus Edge Manager After deployment completes, you can: 1. Access the LEM administration console at `https://:8446`. 2. Access the web interface at `https://`. 3. SSH to the VM using: `ssh @`. Note that port 22 (SSH) is blocked by the firewall by default. Create an inbound rule that allows TCP traffic on port 22 before you connect. [title] Add Security Headers [path] QuickStart Guide/ Complete the following steps to add new security headers to Litmus Edge Manager. # Security Header Directives Refer to the following directives when completing the steps below. ```shell add_header Content-Security-Policy "default-src 'self' https://static.zdassets.com https://ekr.zdassets.com https://ekr.zendesk.com https://litmus.zendesk.com https://*.zopim.com https://zendesk-eu.my.sentry.io wss://litmus.zendesk.com wss://*.zopim.com; img-src 'self' https://litmus.zendesk.com https://media.smooch.io https://v2assets.zopim.io https://static.zdassets.com data:; font-src 'self' data:; script-src 'self' 'unsafe-inline' 'unsafe-eval' https://api.smooch.io https://cdn.segment.com/ https://www.googletagmanager.com https://static.zdassets.com; style-src * blob: 'unsafe-inline'; connect-src 'self' https://api.segment.io/ https://ekr.zdassets.com https://litmus.zendesk.com wss://widget-mediator.zopim.com https://api.smooch.io https://*.config.smooch.io wss://api.smooch.io;"; add_header X-Frame-Options SAMEORIGIN; add_header X-XSS-Protection "1; mode=block"; add_header X-Content-Type-Options nosniff; add_header Strict-Transport-Security "max-age=31536000; includeSubDomains; preload; always;"; add_header Referrer-Policy "strict-origin-when-cross-origin"; ``` # Add New Security Headers 1. Connect to Litmus Edge Manager through SSH. Refer to [Access Litmus Edge Manager](docId\:w3uHZQ4tSrH7OLjhuLt0A) for default login credentials. 2. Open or create the following file: `/etc/nginx/snippets/sec-hdrs.conf`. 3. If the file exists, run the following command to create a backup by running the copy command. `cp /etc/nginx/snippets/sec-hdrs.conf /etc/nginx/snippets/sec-hdrs.conf.bak` 4. Add or modify the file by using the directives above in *Security Header Directives*. - Use the `add_header` directive to add your header. Ensure that each `add_header` statement ends with a semicolon (;). - If a header has components separated by semicolons, use double quotation marks ("") to enclose the text. 5. After editing the file, validate the Nginx configuration with the following command. `sudo nginx -t` 6. If the validation passes without errors, reload Nginx to apply the changes with the following command. `sudo systemctl reload nginx` [title] View Edge Metrics [path] Litmus Edge Manager User UI/Product Features/Edge Devices/ You can view metrics for edge device from the Edge Devices module. Metrics are updated every 30 seconds. # Before You Begin - Ensure you have started metrics pulling. See [Manage](docId\:BoOFh2bJOlfpger0QymmF) for more information. - Ensure the edge devices version are 3.2.0 or later. Metrics are not available for edge device versions prior to 3.2.0. - Obtain an administrator account to receive the permissions to view metrics. **The following metrics are provided**: - Integration disk usage - Integration messages processed - Integration status - Integration tags - Edge device online status - Edge device tags - Edge device topics ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/IpBwwvGODZ4sMku_VH28J_2023-07-1910-16-40.png "View Edge Metrics tooltip") [title] Bulk Actions [path] Litmus Edge Manager User UI/Product Features/Certificates/ :::hint{type="info"} **Note**: This feature is available for Litmus Edge Manager version 2.26.0 and later. ::: The *Certificates Management *pane allows the deployment of certificates to multiple edge devices at once. # Before You Begin Ensure you do the following: - Have imported a ZIP file that contains the necessary certificate configurations and parameters. **To add a certificate in bulk to your edge device(s):** 1. Click **Bulk Actions** button from the *Certificates Management *pane. The *Bulk Actions *dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/XhhvQF0YHJ9iI2VT6kdbQ_image.png" size="70" width="1691" height="624" position="center" caption="Certificates Management pane" showCaption="true"} 2. From the *Select Devices *pane, select the checkbox next to the edge device(s) you wish to add the certificate to. Then, click **Next**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ixQIx3sfqNykg-_3Entng_image.png" size="70" width="1528" height="603" position="center" showCaption="false"} 3. From the *Select Action *pane, select the option you need from: - **Reset to Edge default certificate: **Reset the certificate to the default certificate that comes with the Edge device. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/qtXPfEskAlDf1dtfBIDr0_image.png" size="70" width="1529" height="610" position="center" showCaption="false"} - **Issue a new certificate:** Issue a new certificate for the Edge device. Options include** Litmus Edge Manager** self-signed certificate and [DigiCert](docId\:JD0z31mg3jF1iju1PrU3e) **IoT Trust Manager.** ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/-VEW0AzDEEEz8ynX-mXS1_image.png" size="70" width="1533" height="596" position="center" showCaption="false"} - Then, click **Next**. 4. Review the *Summary* of the target devices and the selected certificate allocation method, and click **Issue certificate**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/DHdDxZ0GN45HYbYwYXtgY_image.png" size="70" width="1527" height="598" position="center" caption="Review page" showCaption="true"} 5. Once the *Status* has changed to *SUCCESS*, click **FINISH**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CwlEcDsUKFIMe5x8Ibhu9_image.png" size="70" width="1527" height="598" position="center" caption="Result pane" showCaption="true"} [title] [path] Litmus Edge Manager User UI/ [title] Application Details [path] Litmus Edge Manager User UI/Product Features/Applications/ You can view a selected application's details from the Applications pane. Viewing an application's details opens the selected Application Details pane. From the *Application Details* pane, you can deploy the selected application. You can start and stop an application, update an application, and view the application logs for a selected edge device from the application details pane. You can select an edge device ID link to view its details. You can select a group and filter the edge devices to narrow the list. # Access Application Details UI **To access the Application Details UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The *Dashboard *pane appears for the project. - Click the **Actions** icon for a project, and then select **View**. The *Dashboard *pane appears for the project. 4. From the Navigation panel, select **Applications**. The *Applications* pane appears. 5. Click the **Actions** icon next to an application, and then select **Details**. The *Application Details* pane appears. ## Litmus Edge Manager version 2.31.0 and later The following image shows Litmus Edge Manager version 2.31.0. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/4dU1Xkd-rQhPkvKZNyf7v_image.png) In the **Application Details** page, you can: - **View the app** See [Application Releases](docId\:V_JC6NJ8Hu8R756NNEr7n) for more details. - **Deploy the app** Click **Deploy Applications** at the right. See [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw) for details. - **Filter edge devices** Filter by release, edge devices status, and app status. - **View edge device details** View the edge device and app status, app name and release version, and the parameters set when the app was deployed. - **Start, stop, update, and delete app and view logs** In the **Actions** menu, select: - **Start Application** Start the application. - **Stop Application** Stop the application. - **Update Application:** After updating an application (deploy a new image of that application to an edge device), you must remove the previous version of that application from the Litmus Edge device. See [Manage Images](docId\:HkWdmj1Xcl6ETf1_A4Xkd) for removal. Obsolete images do not interfere with the new image operations but they do occupy significant disk space. - **Delete Application: **The application does not need to be stopped first to delete it. This delete operation terminates the Docker container and does not remove the Docker image from the Litmus Edge instance. If needed, manually delete the Docker image from the Litmus Edge instance as it does occupy significant disk space. See* Delete image* of [Manage Images](docId\:HkWdmj1Xcl6ETf1_A4Xkd) for details. - **Logs** View logs. ## Litmus Edge Manager version 2.8.0 and later Refer to the following actions you can take on the *Application Details* pane. The user interface below is for Litmus Edge Manager version 2.8.0 and later. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/HfnAlGgVYAQERhzLkgV8x_image.png) | **Action** | **Details** | | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **View Application** | See [Application Releases](docId\:V_JC6NJ8Hu8R756NNEr7n) for details. | | \[2] **Deploy application to device(s)** | See [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw) for details. | | \[3] **Multiple Select** | - Start - Stop - Update Application - Trash | | \[4] **Refresh** | Update the list. | | \[5] **Filter Edge Devices by Group ** | Select specific devices based on conditions. | | \[6] **View Edge Device Details** | [Apps](docId\:pwQmgXarWxphcibP2z12U)**** | | \[7] **Action menu** | Only available for the applications deployed from the *Marketplace Catalog*.
- **Start Application** - **Stop Application** - **Update Application:** Once an application is updated (deploy a new image of that application to an edge device), the previous (now obsolete) version of that application must be removed from the Litmus Edge device. See [Manage Images](docId\:HkWdmj1Xcl6ETf1_A4Xkd) for removal. Obsolete images do not interfere with the new image operations but they do occupy significant disk space, which might pose a problem. - **Delete Application: **The application does not need to be stopped first to delete it. This delete operation only terminate the Docker container, but it does not remove the Docker image from the Litmus Edge instance. Ensure, if needed, you also manually delete the Docker image from the Litmus Edge instance as it does occupy significant disk space. See* Delete image* of [Manage Images](docId\:HkWdmj1Xcl6ETf1_A4Xkd) for details. - **Logs** | [title] User Journey [path] Overview/ The diagram below displays the most common journey of the Litmus Edge Manager experience. These tasks include important edge device management activities, but there are many other capabilities and features available to you in Litmus Edge Manager. ![](https://archbee-image-uploads.s3.amazonaws.com/Q116WJTAr1sefeVNvMCF9-3pS5LIeG6FlfNLfE1Wi9g-20240816-144716.png) **1a.** Review the available options for [Installation and Deployments](docId:0Ft8e3hukX_5V8S8jJkma) to begin your journey. **1b.** After installing, make sure to review the [Post-Installation Checklist](docId\:dC69ksmc0KkrDTK9q8GIy). **1c.** You can review [User Profile Administration](docId\:xFOg2xRprqINGA9cLsZB-) to see how to manage your user account and set up Keycloak two-factor authentication. **2.** To connect an edge device (Litmus Edge instance) with Litmus Edge Manager, you will need to [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB). **3.** You can keep track of connected Edge devices by reviewing the status and metrics in Litmus Edge Manager. To monitor the status of Edge devices, navigate to the *Edge Devices* pane and hover over the **Data | Control** icon to view the device status and additional details. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/q_cg-SoLrdRMOpGDu9HZ2_image.png" size="80" width="1579" height="366" caption="Edge Device status icon" position="center" darkWidth="1579" darkHeight="366" showCaption="true"} To review metrics for an edge device, navigate to the *Edge Devices* pane and click the **Metrics **tab. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/KOIHo2hriuhWsdJjsffxZ_image.png" size="80" width="1503" height="650" caption="The Metrics tab for an Edge device" position="center" darkWidth="1503" darkHeight="650" showCaption="true"} To access more device information, you can view [Edge Device Details](docId\:YwQwD4skuVTwNtcAV5ijs) and [View Data from an Edge Device and/or a Child Device](docId\:E6vquqVSqtUfJIyhmFgOo). You can also review metrics by using Grafana. Learn more about [Grafana Dashboards](docId\:YTC1N5pOOjR1elW34jQmF) and how to [Visualize Child Device Data Using Grafana](docId\:cY2MwkiuvJ2nvNBZhaotC). **4.** You can review details for [Alerts](docId\:BWq6oBkuTNZgIJBIgQPBE) and [Manage Alert Triggers](docId\:ssMqiDTPoBpV95sc3lkaC) for connected devices. This allows you to monitor the activity of edge devices connected to Litmus Edge Manager and receive alerts when important events occur. **5.** The *Applications *module contains a list of catalogs and applications available to the selected project. Litmus Edge Manager includes a default Marketplace catalog with applications ready to be deployed. You can [Manage Applications](docId:1cjuL2kjJIQEBN2kVHjp6) from Litmus Edge Manager and [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw). **6.** **Templates** allow you to create a template from an edge device or upload a template from a file for your edge devices. :::hint{type="warning"} **Important**: Before you can create a template, you must add one or more online edge devices in the Edge Devices pane. ::: Learn more about doing the following: - [Parameterize a Template](docId\:ol2rl-sxp_6Y4ISmGzhXA) - [Apply a Parameterized Template](docId\:nA7fu9L0Lnpo0Ayr7hAOv) - [Apply a Parameterized Template During Activation](docId\:EPSYMUsWZ9uHWcMWMnyaX) **7.** The Digital Twins feature allows you to use data to create models that can predict how a product or process performs. It is a virtual representation of a physical object or system across its life-cycle. You can [Add](docId\:AzdXAlrQzY8jGoXmHHnbR), [Manage](docId\:UDNLsFwTYZfoBnAjsflyK), and [Deploy Digital Twin Models to Edge Devices](docId\:hyW_gkgyU2viMnc0I8Nqg) from Litmus Edge Manager. **8.** The Edge Software module provides you with all the tools needed to manage updates and upgrades of the edge devices managed by Litmus Edge Manager. You can upload the `.upd` file onto the admin console once and it can be used to upgrade edge devices using the Litmus Edge Manager Admin Console *Software update *options. All the images that you load onto the admin console are available for edge device upgrades. You can create groups of edge devices and update them at a specific time or instantly using the upgrade options. You can ensure that edge devices are running on the latest version, manage the disk space used, and view a history of updates. See [Edge Software Update](docId:3IevluZfOdrXAqOOpVT1n) to learn more. **9.** You can enable the Remote UI feature to access and manage your connected edge devices from Litmus Edge Manager. You do not need access to public internet to access your edge devices. Before using this feature, review the *Before You Begin* section in [Open Edge Devices](docId\:XpURI-8b1QSviQEpNCvzD). To use the Remote UI feature, navigate to *Edge Devices* and click the **Open Litmus Edge UI** icon or open the **Action menu** and select **Open UI**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/aRRcMycZR59oGUuwkQn0Z_image.png" size="80" width="1920" height="969" caption="Open Litmus Edge UI icon" position="center" showCaption="true"} [title] Cancel Software Update Tasks [path] Litmus Edge Manager User UI/Product Features/Software Update/ You have the option of canceling individual tasks and multiple tasks at once. :::hint{type="info"} **Note**: These options are available for Litmus Edge Manager version 2.15.0 and later. ::: # Cancel Individual Tasks To delete an individual task, click the **Action menu** for the task and select **Cancel task**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Whh75CyUcKcEJzFyMhyXz_image.png "Cancel task option") # Cancel All Tasks To cancel all tasks, click the **Cancel all scheduled tasks** icon. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/epJERETW8rdHHRq6qlscT_image.png "Cancel all scheduled tasks icon") # Cancel Selected Tasks You have the option of selecting multiple tasks to cancel at once. **To cancel selected tasks:** 1. Click the **Switch multi-select mode** on icon. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1IfzjQEYAmB3ocvNSwFxs_multiselectjobs01.png "Switch multi-select mode icon") 2. Select the tasks you want to cancel. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Sbjbk6grVOtZVqkpOXZq5_multiselectjobs02.png "Click checkboxes to select tasks") 3. Click the **Cancel task** icon. The *Confirmation *dialog displays. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/cE9LDZuukLyYaHTbmWOCj_multiselectjobs03.png) 4. Confirm the cancelation and click **YES, CANCEL**. The selected tasks are canceled. [title] Edge Devices [path] Litmus Edge Manager User UI/Product Features/ Once you [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) from Litmus Edge Manager, you can do the following from the *Edge Devices* page: - View details such as the device ID (UUID) and data/control status for each device - View metrics - Deactivate or delete a device - Open the edge device UI in a new browser tab - View edge devices that have expired licenses # Access Edge Device UI **To access the Edge Device UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the Project pane. - Click the **Actions** icon for a project, and then select **View**. 4. From the navigation panel, select **Edge Devices**. The *Edge Devices* pane appears. Refer to the following actions you can take on the *Edge Devices *pane. The user interface below is for Litmus Edge Manager version 2.10.1 and later. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/j90DbxZfeJQCnB5bnsiCZ_2023-08-0810-10-09.png "Edge Devices ") :::hint{type="info"} **Note**: If the child device's tag is removed from the *Default Generic MQTT SSL connector*, the child device is not deleted from the list of available child devices and will still be displayed. ::: | **Action** | **Details** | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Show child devices** | Before a child device can be viewed, that child device's tag must be added or imported to the* Default Generic MQTT SSL connector* in the child's parent Litmus Edge instance. See [Set up Default Generic MQTT SSL Connector with Imported Topics in Litmus Edge](docId\:E6vquqVSqtUfJIyhmFgOo) for details. | | \[2] **View **[Edge Device Details](docId\:YwQwD4skuVTwNtcAV5ijs)** ** | Provides comprehensive information about the selected edge device. | | \[3] [Open Edge Device](docId\:XpURI-8b1QSviQEpNCvzD) | Launches the user interface of the selected edge device. | | \[4] [View Edge Metrics](docId\:LN8vukirANWG3gtEM9pA2) | Displays performance metrics related to the selected edge device. | | \[5]** View Data and Control Status** | Shows the current data and control connectivity status for the edge device. | | \[6] **Action menu** | - **Deactivate: **This action will disconnect the *Data \| Control* for the selected edge device. - **Delete: **Once an edge device is deleted, the delete status update updates in real time. However, the actual deletion from Litmus Edge Manager takes place after a 24-hour period. - **Open UI** / **Open UI (new tab)** | | \[7] **Open filter** | Search by *Id / Name*, *Friendly Name*, or *Version.* | | \[8] [Multi-Select Mode](docId\:CxDWBdmKV_Ovs5CcwpTes)**** | Use this feature to *group* several devices at the same time. | | \[9] **Advanced Filter** | Provides enhanced filtering options for more refined device searches. | [title] Licenses [path] Litmus Edge Manager User UI/Product Features/ :::hint{type="info"} **Note: ***Licenses Summary *homepage has been updated and is available for Litmus Edge Manager version 2.18.0 and later. ::: In **Licenses**, you can do the following: - Track and analyze license key statistics - View total, active, used, expired, or unused licenses - Track activation details - Filter usage and availability in real-time You can also manage core and add-on licenses, conduct bulk uploads and deployments, generate CSV reports, and use advanced configuration options for license activation using SKUs. For more detailed information on licenses, see [Site and Node-Locked License Overview for Litmus Edge Manager](docId\:Jvibd0MBSj97ZcPDfhab9). :::hint{type="info"} **Note**: The Licenses module is available from an open project. ::: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/tiggS5MwmBMjJLLPTqL3i_image.png) :::hint{type="info"} **Important for Cloud Deployment**: Before activating the license, ensure all hardware/VM configuration steps that can modify the MAC address (add/replace a Network Interface Controller (NIC) card) are finalized. The license Host ID depends on the Media Access Control (MAC) address for the device. The MAC address identifies the devices on a network. Changing the MAC address will invalidate the license. ::: # Access Licenses UI **To access the Licenses UI:** 1. Log in to Litmus Edge Manager. 2. Select a company and project. The *Projects* pane appears. 3. From the Navigation panel, select **Licenses**. The *License Summary* pane appears. Refer to the following actions you can take on the Litmus Edge Manager User UI's *Licenses* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/9QcG7GodjqAt7B8KUMu8w_lem-licenses-02.png) | **Action** | **Details** | | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **License Usage Statistics** | - Licenses Types - Core - Add-on - Total Licenses - Used Licenses - Active - Expired - [Un-Used Licenses](docId\:qLrNQnUbla_1ayCXro-eU)**** | | \[2] **Filter** | Refine displayed license data based on specific criteria. | | \[3] [Bulk Deploy Licenses](docId\:PlUrdxfMXIX0dCpApy0_H) | Deploy licenses in bulk for multiple devices. | | \[4] [Generate a Report](docId\:NayEcoyMir18JHrrDQCRl) | Create summary reports of license usage and statuses to download an use locally. | | \[5] [Upload License CSV](docId:9oVnX_gYLpZzZB_lTGjdO) | Upload license info in CSV format for bulk management. | | \[6] [Edge Device Details](docId\:YwQwD4skuVTwNtcAV5ijs) | View specific information about associated edge devices. | | \[7] **Action menu** | Access options to deploy licenses and show license features.
- **Deploy License: **See [Bulk Deploy Licenses](docId\:PlUrdxfMXIX0dCpApy0_H) for details. - **Show license features** | [title] Task List and Task Details [path] Litmus Edge Manager User UI/Product Features/ :::hint{type="info"} **Note**: The Task List and Task Details feature is available for Litmus Edge Manager 2.7.0 and later. ::: The Task List and Task Details feature is designed to monitor and track the status of all tasks that can be applied concurrently to multiple Litmus Edge instances. When the tasks are complicated enough and are applied to enough instances, they could require a lot of computing resources and time to complete. Only tasks in the last 24 hours will be automatically displayed. LEM can only monitor and track the following: - [Apply a Parameterized Template](docId\:nA7fu9L0Lnpo0Ayr7hAOv) - [Add New Software Job](docId\:i24b2ShVA4EeOxUPftj_M) - [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw) - *Start Application, Stop Application, Update Application, Delete Application* of [Application Details](docId\:IwpC69go6bc_ZOQ2smTg4) - *Push Marketplace catalogs to Edge devices* of [Manage Applications](docId:1cjuL2kjJIQEBN2kVHjp6) # Access Task List and Task Details **To access the task list and task details: ** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The Dashboard pane appears for the project. - Click the **Actions** icon for a project, and then select **View**. The *Dashboard *pane appears for the project. 4. From the top right corner, do one of the following: - Click one of the tasks to access the task's *Task Details* - Click **Show all tasks** to access the *Task List* ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/fwi0lkBqzN8d02R3RM08u_image.png" size="80" width="1920" height="914" caption="Accessing Task List or Task Details" position="center" showCaption="true"} # Task List The Task List keeps a history of Litmus Edge Manager tasks and their progress. This feature enables you to monitor the progress of these tasks. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/QGk3rCtrIx_z-9YeR1YRl_2023-07-2716-16-24.png) | **Action** | **Details** | | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Show filter** /** Hide filter** | Toggles the visibility of filter options to organize and narrow down the displayed tasks effectively. | | \[2] **Show task details** | Reveals in-depth information about a selected task, including its progress and associated sub-tasks. | | \[3] **Open task page** | Navigates to the detailed view of a specific task for more comprehensive insights and management options. | | \[4] **Action menu** | Provides a dropdown of actions, including viewing, editing, or deleting task details for streamlined task management. | | \[5] **Select Task Type** | Allows users to filter tasks based on category, such as applying templates or managing Marketplace applications.
* All * Apply template * Software update * Launch Marketplace application * Start Marketplace application * Stop Marketplace application * Delete Marketplace application * Upgrade Marketplace application * Sync Marketplace * Refresh Marketplace application cache | | \[6] **Select Task Status** | Enables users to filter tasks by their current status, including new, running, successful, or error states.
* All * New * Running * Success * Error | | \[7] **Select Task Created From** | Sets the starting date for filtering tasks created from that specific date, with the current date set as the default. | | \[8] **Select Task Created To** | Defines the ending date for filtering tasks up to that particular date, allowing users to refine their task search by date range. | # Task Details Task Details provides additional information about a specific task by displaying the task's multiple sub-tasks and their respective details. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/5nAeLK7duSK7QuyfWsHqk_tomv3trarxkegu5yc7kquimage.png "Litmus Edge Manager Task Details") | **Action** | **Details** | | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | \[1] **View Subtask Log** | Displays messages related to specific sub-task activities. | | \[2] **Open task page** | Directs to detailed information of the selected task. | | \[3] **Open device details** | Shows information about devices associated with the task.
* [Info](docId:6_6LCntLNjWrq1JBqAS8e) | | \[4] **Change to Table**/**Module view** | Switches between table and module presentations of tasks.
* View log | ## Subtask Log The subtask log displays messages related to a single sub-task. Any log message that appears here will also show up in the *System Events *tab of* Projects events* in [Events](docId\:Qh9PnCUT-G1k_Lz9p4-m3). ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/W8MGURmj2GS-h7UseWuFB_7uf0tidqngpzf7fdf3gpu2023-07-1710-10-23.png "Litmus Edge Manager Subtask Log") [title] Example: Create a Basic Activation Configuration [path] QuickStart Guide/Activate an Edge Device/Step 2: Create an Activation Configuration in Litmus Edge Manager/ What follows is a simple example of an activation configuration in Litmus Edge Manager for an edge device activation. Please refer to [Step 2](docId\:vVZ99_j_TGxX6b9-Y9f8L) for more information and the general procedure. **To create a basic configuration:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Click a project from the Project pane. The *Dashboard* pane appears for the project. 4. From the navigation panel, select **Activation**. The *Configuration* and *Requests* sub-modules drop down. 5. From the navigation panel, select **Configuration**. The *Activation Configuration* pane appears. 6. Click the **Add (+)** icon. The *Activation Config List/ NEW *pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/PT0YDQ4ibjxogxl2BfZkt_2023-07-1913-01-01.png "Activation Configuration: Add button") 7. (Optional) Customize the following characteristics according to your requirements. - Limits - Number of edge devices - Lease TTL - Expiration Date - License Type: Node-Locked vs Site - Node-Locked License Keys - Templates - Template Variables - Provision Options - Advanced Settings 8. Click **Save**. The activation configuration you have created is saved. For site-based licenses, the edge device activation code appears in the *Activation Code* field of the *Activation Code* section. 9. Copy aside the *Activation URL* and *Activation Code* values. They will be needed for the activation and configuration of a Litmus Edge instance. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/jAZIekxm9Mpl9rXiYeKyf_2023-07-2715-48-30.png "Activation Code and Activation URL") **Proceed to **[Step 3: Create an Activation Request in Litmus Edge](docId:0AxUENzrqbUXfriiPUYlh)**.** [title] Activate an Edge Device [path] QuickStart Guide/ Before an Edge device can be managed centrally, it must be activated. Activation establishes: - Secure communication between Litmus Edge and Litmus Edge Manager - License compliance (node-locked or site-based) - Centralized control of device configurations Think of activation as the handshake that allows your Edge device to join the Litmus ecosystem. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/GnT5Ru7vlYg3DiFOutYyN-20251127-230839.png) ### Step 1: Verify Compatibility - Ensure your **Litmus Edge version** matches the **Edge Manager version**. See [Step 1: Verify Litmus Edge- Litmus Edge Manager Compatibility](docId\:lpIY4g2pqsn7iJfPKgamz). - Incompatible versions may cause API errors or missing features. ### Step 2: Create Activation Configuration - Navigate to **Edge Manager **>** Devices **>** Activation Config**. - Fill in required parameters: - Device ID - License key - Server URL/port - This configuration file acts as the identity card for your device. ### Step 3: Request Activation - Upload the activation config from your Edge device. The device sends a request to Edge Manager. - Pending requests appear in the **Activation Queue**. ### Step 4: Approve Request - An administrator reviews and approves the request. - Approval ensures only trusted devices join the network. - Once approved, the device is officially recognized. ### Step 5: Verify Activation - Confirm the device appears in the **Active Devices list**. - Check connectivity status (green indicator). - Run a quick test: send sample data to Edge Manager. ### Step 6: Enable MQTT SSL Connector - Go to **Connector Settings** and enable **MQTT with SSL**. - MQTT is the default protocol for data transfer, and SSL ensures encryption. - This step secures all communication between Edge and Manager. ### Troubleshooting - **License mismatch**: Double-check license type and key. - **Firewall blocking port**: Ensure server port is open. - **SSL certificate error** → Verify certificates are valid and not expired. *Best Practice:* Always sync device time with NTP before activation to avoid certificate issues. # Video :::Iframe{iframeHeight="0" code=""} ::: [title] Edge Remote Network [path] Litmus Edge Manager User UI/Product Features/Remote Access/ After you have activated an edge device (See [Activation](docId:0vtl5o6-X3oMmsEDaTaoP)) from within Litmus Edge Manager, that device's remote connection information is displayed automatically in that pane. The list of edge device connections includes the following information. - Peer ID - Peer name (hostname) - Edge Device ID - Friendly name - Allowed IP address (subnet mask) - Traffic In | Out - Online status for the peer - Date and time the peer was last online On the *Edge Remote Network* pane, you can: - View and copy the network name, as well as the connection's subnet address - Display an edge device's details by clicking its ID on the list - Refresh the Edge Remote network - Enable or disable auto-refresh for the Edge Remote network - Remove a peer node (edge device connection) # Access Edge Remote Network UI **To access the edge remote network UI: ** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project* pane. The *Dashboard* pane appears for the project. - Click the **Actions** icon for a project, and then select **View. ** The *Dashboard* pane appears for the project. 4. From the Navigation panel, select **Remote Access**. The *Zerotier Network* tab appears by default. 5. Click the **Edge Remote Network** tab. The *Edge Remote Network* pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Hi22xh2E0evxDV-AKQUB6_coixbmx3klusd-jlruqqgimage.png "Edge Remote Network tab") | **Action** | **Details** | | ------------------------------------------------------------------ | -------------------------------------------------------------------------------- | | \[1] **Copy to clipboard Network Name** | Copies the network name for easy access. | | \[2] **Copy to clipboard Subnet** | Copies the subnet address for configuration. | | \[3] **View** [Edge Device Details](docId\:YwQwD4skuVTwNtcAV5ijs) | Displays detailed information about the device. | | \[4] **View Edge Device status** | Shows the current online status of the device. | | \[5] **Action menu** | - Delete | | \[6] **Auto Refresh** | Automatically updates the network information regularly by 5, 10, 30, 60 seconds | [title] Overview [path] / ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ianfKvIKm19gwUNVS_5du_lem.png) Litmus Edge Manager is a centralized management platform for edge devices, data, and applications at the edge. As a single point of control for all Litmus Edge instances (edge devices), Litmus Edge Manager handles large-scale deployments across multiple facilities. Litmus Edge Manager gives you control over edge devices, from bootstrap to replacement, with secure mass deployment, over-the-air updates, and automated actions. Litmus Edge Manager offers an option to act as a central data repository. It is used to set up and manage all aspects of a Litmus Edge environment. You can access Litmus Edge Manager from a software-defined private network anywhere, using: - Web User Interface - REST APIs: to manipulate data programmatically For more information on how Litmus Edge Manager can manage Litmus Edge devices, start with [Litmus Edge Manager User UI](docId:-sKldTrdGJ49xNOa3yycd). For more information on how to configure and manage the Litmus Edge Manager itself, start with [Litmus Edge Manager Admin Console](docId\:run1qmlV1AuZ9aleqIakZ). # Functionality The Litmus Edge Manager User UI and Litmus Edge Manager Admin Console: - Connect to any number of edge devices to provide extensive management capabilities - Offer edge device templates for fast and consistent deployment - Manage Docker-containerized applications for edge devices - Deploy applications across multiple edge devices - Integrate edge devices with cloud or enterprise systems, including Big Data - Store data in all types of databases and cloud storage systems - Manage dashboards to generate KPI reports and visualize real-time data across all edge devices - Provide central AI/ML model management for training, deployment, and lifecycle control - Enable central license management to streamline compliance and usage tracking - Support central certificate management for secure edge device communication - Offer access control and edge device user management - Provide audit logs and activity tracking for governance and compliance # Frequently Asked Questions [Litmus Edge Manager FAQs](docId\:RSQ7IU9K04RS6UiGUc_j2) [title] Edge Device Details [path] Litmus Edge Manager User UI/Product Features/Edge Devices/ Edge Device Details allows you to manage the edge devices connected to Litmus Edge Manager. Each edge device includes device properties, collected data, and connectivity information for the device. There are tabs that are available for viewing and configuration. The edge device tabs are specific to a device type. Tabs relevant to the selected edge device are displayed # Access Edge Device Details UI **To access the Edge Device Details UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The *Dashboard* pane appears for the project. - Click the **Actions** icon for a project, and then select **View**. The *Dashboard* pane appears for the project. 4. From the Navigation panel, select **Edge Devices**. The *Edge Devices* pane appears. 5. Click an edge device **ID** link in the Edge Devices pane. The selected *Edge Device Details* page open with the **Info** tab. 6. (Optional) Hover over the **Data | Control** icons to view a drop-down status for the selected edge device. This edge device status is viewable from all tabs in the selected edge device details pane. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/8PM13XLOtDpyBYY8nx2gD_image.png" size="80" width="1920" height="850" position="center" caption="Edge Device Details" showCaption="true"} [title] Select a Company [path] Litmus Edge Manager User UI/Product Features/Company List/ You can [create multiple companies](docId\:QS1mbPG-tWRCyAAWe5Iya) and then select different companies to work with. As each company is designed to contain its own teams, projects, data collection, and device management, this achieves data security by creating a domain-level isolation between other companies or business units. In a multi-tenancy environment, you can create a company for each of your client companies. In a large corporation, a company can be used to represent a business unit. You can select a company to work within when you log in, from the *Companies *list or from the *Company *drop-down list. You can search for a company in the Companies list. :::hint{type="info"} **Note: **The company you select displays at the top of the window to indicate the context for the configuration. You can switch companies by making a selection from the *Company Name* drop-down list at the top of the window. ::: **To select a company after logging in**: 1. Log in to *Litmus Edge Manager.* A list of companies appears. The user interface below is for Litmus Edge Manager version 2.10.1 and later. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/GYOFC2UCrYhfeCn49LKF6_jhfngeksa562-ctx2nxkr2023-07-1416-46-11-1.png "Companies List") 2. Select a company from the list. The* Projects* pane for the selected company appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/j8NwvgChh5XwvYVb6RldC_juks5j6lh2dve4rzs4c4f2023-07-1416-47-14.png "Projects List") **To select a company from the Company drop-down list:** From the company or project from which you are working, select an option from the **Company **drop-down list. The *Projects* pane for the selected company appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/u6DQGppHJTFR4Rsqtigub_n4m766-zlwr9snubz51h12023-07-1416-48-06.png "Return to Company List") [title] Deployment of Litmus Edge Manager on Azure Kubernetes Service (AKS) [path] QuickStart Guide/Installation and Deployments/ You can deploy Litmus Edge Manager on **Azure Kubernetes Service (AKS)**. You deploy with the following steps: - [Step 1: Set up your AKS Cluster](docId:8RhqJWbbMvu1pTv95zfjj) - [Step 2: Connect to Your Cluster](docId:8RhqJWbbMvu1pTv95zfjj) - [Step 3: Execute Kubectl and Helm Commands](docId:8RhqJWbbMvu1pTv95zfjj) - [Step 4: Upgrade the Helm Chart](docId:8RhqJWbbMvu1pTv95zfjj) - [Step 5: Access the Litmus Edge Manager UI using the obtained IP address](docId:8RhqJWbbMvu1pTv95zfjj) # Before You Begin Before you begin, make sure that you have: - A valid [Microsoft Azure](https://azure.microsoft.com/en-us/pricing/purchase-options/azure-account) subscription with permissions to create and manage Kubernetes clusters. See the [Azure Kubernetes Service (AKS)](https://learn.microsoft.com/en-us/azure/aks/) documentation for more details. - Familiarity with the [Azure Portal](https://learn.microsoft.com/en-us/azure/azure-portal/azure-portal-overview) and [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/?view=azure-cli-latest). - Installed [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) on your local machine. - Installed [HELM CLI](https://helm.sh/docs/intro/install/) and [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) on your local machine. - Available Litmus Google registry credential key file (for example, `LEM_pull_Key_file.json`). # Minimum Virtual Machine Requirements You can meet virtual machine requirements using a single node or multiple smaller nodes. Recommended specifications for production environments depend on your individual use cases. The minimum virtual machine (VM) requirements are: - Recommended node size: 8 CPU and 20 GB memory - Storage Configuration: 100 GB local storage - Suggested node pool strategy: - Single node, for example Standard\_D8s\_v3 or Standard\_D8as\_v\* - Multi-node with smaller nodes where combined resources meet or exceed 8 CPU cores and 20 GB RAM # Step 1: Set up your AKS Cluster in your Azure Portal account 1. Log in to your Azure account. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/-w6tANuXEHbLZujPrcANO_image-20250818-164218.png" size="80" width="1933" height="947" position="flex-start" showCaption="false" indent="2"} 2. Open Azure Kubernetes Service. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6OJSgOXebfHUDgZh8WBRw_image-20250818-164402.png" size="80" width="1247" height="627" position="center" showCaption="false" indent="2"} 3. Select your subscription and plan: **Azure Kubernetes Service (AKS)**. Click **Create**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/UXZGgxAIIbuKW2Oqwxam9_image-20250818-164736.png" size="80" width="1400" height="783" position="flex-start" showCaption="false" indent="2"} 4. In **Create Kubernetes cluster** > **Basics**, set the following: - **Subscription** Your subscription is selected already. - **Resource Group ** Create a new resource group to contain the cluster resources. - **Cluster preset configuration** Select `Dev/Test`. - **Kubernetes cluster name** Set any desired name for the cluster. - **Region** Set any or `(US) East US`. - **Kubernetes version** Set any or `1.32.6 (default)`. - **Authentication and Authorization** Local accounts with Kubernetes RBAC. - **Other options** Leave default values or modify as required. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/cU-EqtOymRf7PXgYV9YIb_image-20250818-170252.png" size="80" width="1245" height="1163" position="flex-start" showCaption="false" indent="3"} 5. In the **Node Pools** tab: 1. Confirm that the `agentpool` node pool is created for you already. 2. Make sure the node pool is using `Ubuntu Linux` and the minimum node count is `2`. 3. Optionally, create a custom node pool by clicking on **Add node pool**. **Note: **Pay attention to the `maximum `node count. The deployment will fail if this is set to `2` and the **Max pods per node** is set to `40` or below. In this case, the cluster would need an additional node (3) to distribute all the pods. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Fu5m0bdsyboVobtG7hI-R_image-20250818-171738.png" size="80" width="1041" height="997" position="flex-start" showCaption="false" indent="3"} 6. Set the following in the **Networking** tab: - **Enable private cluster** Leave this unselected. - **Set authorized IP ranges** Leave this unselected. - **Network configuration** Azure CNI Overlay. - **DNS name prefix** Set your custom DNS name prefix. - **Network policy** None or modify is needed. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/G71_2vkCi0dRaR92V8wdZ_image-20250815-130041.png" size="80" width="1406" height="1035" position="flex-start" showCaption="false" indent="3"} 7. In the **Integrations** tab, use the default values. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/IQSuay_7tpaH4qEpfZ-jp_image-20250819-072905.png" size="80" width="1156" height="876" position="flex-start" showCaption="false" indent="2"} 8. In the **Monitoring** tab: 1. Select **Enable Prometheus metrics**. 2. **Azure Monitor workspace** Your workspace is already selected. 3. Select **Enable recommended alert rule**. 4. **Alert rules** Review details and confirm the email for alerts. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/fH7H1B8yKqgvlUjz6j54k_image-20250819-073634.png" size="80" width="1156" height="876" position="flex-start" showCaption="false" indent="3"} 9. Use the default values in the **Security** and **Advanced** tabs. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/u3KJCfure0xXDCSrha-b-_image-20250819-073855.png" size="100" isUploading="false" width="1057" height="878" showCaption="false" indent="2"} 10. In the **Tags** tab: 1. Add your tags as desired. 2. Add the tags to all resources. 3. Click **Review + create**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/XctgWSbIhuiaREpu7wsEW_image-20250819-074630.png" size="100" width="1200" height="878" darkWidth="800" darkHeight="585" position="flex-start" showCaption="false" indent="3"} 11. In **Review + create**: 1. Review your settings. :::hint{type="info" indent="3"} **Note:** Double-check the following minimum VM requirements: - The nodes use Ubuntu Linux OS - Architecture is AMD64 - VM: 8 CPU cores and 20 GB Memory ::: :::Paragraph{listStyleType="decimal" listStart="2" indent="2"} Ensure that the validation passes. ::: :::hint{type="info" indent="3"} **Note**: If you see `Validation failed. Required information is missing or not valid.` return to that tab and add or correct the required information. ::: :::Paragraph{listStyleType="decimal" listStart="3" indent="2"} Click **Create**. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/aRGOjhP2ZpLiLpE-I3wG6_image-20250819-075005.png" size="100" width="1081" height="294" darkWidth="800" darkHeight="217" position="flex-start" showCaption="false" indent="3"} :::hint{type="info"} **Note:** Creating a cluster takes a few minutes depending on the settings you choose. Check the status or notifications for the latest information about your cluster. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Kw6bTKEUhnV7WMfqjyGp1_image-20250819-075710.png" size="80" width="1489" height="882" position="flex-start" showCaption="false"} # Step 2: Connect to Your Cluster Open your terminal and log in with Azure CLI. 1. In the Terminal window, type in `az login`. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/GX8L2YvIJR5ZM-cxjAQ8H_image-20250819-084832.png" size="80" width="1075" height="755" position="flex-start" showCaption="false" indent="2"} 2. In the **Auth UI dialog**, select the Microsoft Azure account that has access to the AKS service. Enter your credentials. 3. In the Terminal window, select a subscription and tenant. Make sure you select the subscription where your AKS cluster is created. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/GPMRv3wGbnYfTEPDBMmty_image-20250819-084549.png" size="80" width="1463" height="310" position="flex-start" showCaption="false" indent="2"} Next, connect to your cluster. 1. Open the Azure portal and navigate to **Kubernetes services**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/YFvfFK8lOgkI95egGhtIJ_image-20250819-085204.png" size="100" isUploading="false" width="1669" height="601" showCaption="false" indent="2"} 2. In **Kubernetes services**, select your cluster. 3. In the cluster page, click **Connect**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/EHIXurITiwYM6hdg-4pX3_image-20250819-085829.png" size="80" width="1879" height="774" position="flex-start" showCaption="false" indent="2"} 4. In the **Cloud shell** tab, copy the second command: :::CodeblockTabs{indent="2"} ```bash az aks get-credentials --resource-group --name --overwrite-existing ``` ::: 5. In the Terminal window, paste the command with updated values for `` and ``. 6. Submit the command. You should see similar output in your terminal: :::BlockQuote Merged "my-dev-cluster" as current context in C:\Users\user\\.kube\config ::: The cluster setup is now complete. # Step 3: Execute Kubectl and Helm Commands in your Terminal In this section you create an `lem` namespace and pull secret, configure the load balancer and install Helm. 1. Create an `lem` namespace. :::CodeblockTabs{indent="2"} ```bash kubectl create ns lem ``` ::: 2. Create a pull secret. Change the command accordingly based on the location of your pull key file on the local machine. :::CodeblockTabs{indent="2"} ```bash kubectl create secret docker-registry lem-helm-secret \ --docker-server=us-east1-docker.pkg.dev \ --docker-username=_json_key \ --docker-password="$(cat LEM_pull_Key_file.json)" -n lem --docker-email=any@email.com -n lem ``` ::: 3. Next specify values to configure the load balancer, where: - `lem.platform: aks` specifies the AKS annotation set. - `lem.loadbalancer.internal:` true or false specifies whether the chart injects the AKS `internal LB` annotation. - `lem.loadbalancer.ip.frontend` and `.remote` enable you to assign static IPs for the two LB services (nginx + remote). :::CodeblockTabs{indent="2"} ```bash # values-aks.yaml lem: platform: aks loadbalancer: internal: false # set true for internal/private LB ip: frontend: "" # optional: reserved static IP for nginx LB remote: "" # optional: reserved static IP for UDP 51820 LB ``` ::: 4. Install Litmus Edge Manager using the following command, where `` is the LEM version that you are installing, for example `--version 2.31.0` :::CodeblockTabs{indent="2"} ```bash helm install lem oci://us-east1-docker.pkg.dev/litmus-public/lem-chart-ga/lem \ --version \ -n lem \ -f values-aks.yaml ``` ::: :::hint{type="info"} **Note: ** - The command initiates the pull of the required container images. This process may take several minutes. - Make sure the secret name is `lem-helm-secret` and that you don’t override it with `--set "imagePullSecrets[0].name`. - After the deployment is completed, wait approximately five minutes before applying the Litmus Edge Manager (LEM) URLs and credentials. - Instructions for accessing these URLs and credentials print for you in the console. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/XJtWQ91VOhu2v1sMQ8JzV_image-20250819-110531.png" size="80" width="1788" height="581" position="flex-start" showCaption="false"} To get URLs and credentials for Litmus Edge Manager: 1. In case you need URLs and credentials after the deployment, execute the following: :::CodeblockTabs{indent="2"} ```bash helm get notes lem -n lem ``` ::: 2. To get Litmus Edge Manager's external IP, run the following, where `-nginx` is your service name: :::CodeblockTabs{indent="2"} ```bash kubectl get svc lem-nginx -o jsonpath='{.status.loadBalancer.ingress[0].ip}' -n lem ``` ::: 3. To get the LEM username and password, run: :::CodeblockTabs{indent="2"} ```bash # username kubectl get secret --namespace lem lem-secret -o jsonpath="{.data.lem-user}" | base64 --decode # password kubectl get secret --namespace lem lem-secret -o jsonpath="{.data.lem-password}" | base64 --decode ``` ::: # Step 4: Upgrading the Helm Chart If you are upgrading Litmus Edge Manager to a new version, first upgrade the Helm chart. 1. Before the upgrade, scale down Prometheus: :::CodeblockTabs{indent="2"} ```console kubectl -n lem scale deployment lem-prometheus-server --replicas=0 ``` ::: 2. If upgrading from a version before 2.31.1, delete EMQX resources: :::CodeblockTabs{indent="2"} ```console kubectl -n lem delete statefulset lem-emqx kubectl -n lem delete configmap lem-emqx-acl kubectl -n lem delete configmap lem-emqx-env kubectl -n lem delete configmap lem-emqx-loaded-modules kubectl -n lem delete configmap lem-emqx-loaded-plugins kubectl -n lem delete service lem-emqx kubectl -n lem delete service lem-emqx-headless ``` ::: 3. Run the Helm upgrade. Use the actual chart version instead of the `` placeholder. :::CodeblockTabs{indent="2"} ```console helm upgrade lem oci://us-east1-docker.pkg.dev/litmus-public/lem-chart-ga/lem --version --namespace lem ``` ::: 4. After the upgrade, scale Prometheus back up: # Step 5: Access the Litmus Edge Manager UI using the obtained IP address See [Access Litmus Edge Manager](docId\:w3uHZQ4tSrH7OLjhuLt0A) for details. :::hint{type="info"} **Note:** Get the Site License key from your Litmus account executive to activate your license. ::: Litmus Edge Manager is now deployed and operational on your AKS cluster. You can now access the manager’s UI using the external IP address and perform any additional configuration through the admin console, such as license activation. [title] System Requirements [path] QuickStart Guide/ The following system requirements are for an ESXi-based deployment for Litmus Edge Manager. :::hint{type="info"} **Note**: ESXi or a similar hypervisor is required to deploy Litmus Edge Manager. Bare metal deployment is not supported. ::: :::hint{type="warning"} **Important**: Depending on system resources, first time installation setup may take up to 30 minutes to complete. ::: # Minimum Requirements Review the following minimum requirements for desktop distribution. | **Hardware** | **Minimum Requirements** | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Processor | - Intel x86 64-bit processor - 16 Core\@2.2Ghz (Example: Intel i5) | | Memory | 16 GB RAM | | Storage | 80 GB available space | | Network ports | 1 Bridged
Direct connection to corporate LAN allows for internet connection and other TCP/IP communication to other systems. An available IP is required. | | Firmware | EFI | | Storage Controller Type | SATA | # Recommended Configurations Review the following recommended configurations for data center distribution. | **Hardware** | **Recommended Configuration** | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Processor | - Intel x86 64-bit processor - 32 Core\@2.2Ghz (Example: Intel Xeon) | | Memory | 32 GB RAM | | Storage | 1 TB available space or more | | Network ports | 1 Bridged
Direct connection to corporate LAN allows for internet connection and other TCP/IP communication to other systems. An IP address must be acquired to this. | | Firmware | EFI | | Storage Controller type | SATA | # Firewall Port Configuration Requirements The Litmus Edge Manager must have the following ports open for the following corresponding functions. | **Port** | **Protocol** | **Encrypted** | **Optional** | **Direction** | **Port Function / Usage for Litmus Edge Manager** | **Description / Additional Details** | **Source**
**(Port is used by who/what)** | **Destination**
**(Port must be opened at)** | | -------- | ------------ | ------------------------------------------------ | ------------ | ------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------- | | 22 | TCP | Yes
Session Key | Yes | Inbound | SSH | Managing a Litmus Edge
Managing instances using SSH | Litmus Edge Manager 
Admins | Litmus Edge Manager | | 80 | TCP | Redirects to HTTPS | Yes | Inbound | HTTP, redirect SSL | Accessing Litmus Edge Manager UI if you entered only the domain name without the protocol in a browser
Domain validation when using Let's Encrypt SSL | Litmus Edge Manager 
users | Litmus Edge Manager | | 123 | UDP | No | Yes | Inbound | Network Time Protocol | Used to transform Litmus Edge Manager version 2.8.0 and later as an NTP Server. See [NTP](docId\:hRmAskLSu9CAdrlP7k-UE) for details. | Litmus Edge | Litmus Edge Manager | | 443 | TCP / HTTPS | Yes
SSL | No | Inbound | Access to Litmus Edge Manager UI | Access to Litmus Edge Manager REST API
Access to Litmus Edge Manager Admin Docker registry
Access to Keycloak authorization server
Used by Litmus Edge Manager to communicate with Litmus Edge
Pre-signed links are generated on this port.
Minio Storage
(Update file repo) | Litmus Edge

Litmus Edge Manager 
users | Litmus Edge Manager | | 8123 | TCP | No
optional (settable on screen) | Yes | Inbound | Litmus Edge Manager 
Clickhouse database HTTP interface | | Third-party Integration / Reporting tools | Litmus Edge Manager | | 8446 | TCP | Yes
SSL | No | Inbound | Access to Litmus Edge Manager Admin UI | | Litmus Edge Manager 
Admins | Litmus Edge Manager | | 8543 | TCP | Yes
SSL | Yes | Inbound | Litmus Edge Manager 
Clickhouse database HTTPS interface | | Third-party Integration / Reporting tools | Litmus Edge Manager | | 8883 | MQTT / TCP | Yes
MQTTS | No | Inbound | Litmus Edge Manager MQTT server | CC Connector: Sending data from Litmus Edge to Litmus Edge Manager | Litmus Edge | Litmus Edge Manager | | 9000 | TCP | Optional (encryption initiated from client side) | Yes | Inbound | Litmus Edge Manager 
Clickhouse Native interface | | Third-party Integration / Report tools | Litmus Edge Manager | | 9004 | TCP | Optional (encryption initiated from client side) | Yes | Inbound | Litmus Edge Manager 
Clickhouse MySQL interface | | Third-party Integration / Reporting tools | Litmus Edge Manager | | 9092 | TCP | Optional (encryption initiated from client side) | Yes | Inbound | Access to Litmus Edge Manager 
Kafka PLAIN connection | | Third-party Integration / Reporting tools | Litmus Edge Manager | | 9093 | TCP | Yes
SSL (Optional) | Yes | Inbound | Access to Litmus Edge Manager Kafka SSL connection | | Third-party Integration / Reporting tools | Litmus Edge Manager | | 51820 | UDP | Yes
Remote Access | No | Inbound | EdgeRemote
(uses Remote Access) | Enables Litmus Edge Manager management (Remote UI, templates, marketplace, metrics and so on) of all connected Litmus Edge instances.
Used for remotely updating the version of connected Litmus Edge instances.
Requires 443 to be open. | Litmus Edge | Litmus Edge Manager | [title] Manage Device Requests [path] Litmus Edge Manager User UI/Product Features/Activation/Requests/ The* Activation Request List*** **includes all the activation codes for your edge devices. You can approve, reject or remove an activation code, view the activation and provision status, and copy the activation code from here. When you select an** Activation code** link from the Activation Request List, The Activation Config List appears. See [Configuration](docId\:Jr3PpIPRQ-O49pFdJHDkN) for more information about what the Activation Config List includes. Refer to the following actions you can take on the Litmus Edge Manager User UI's *Activation* *Request List* tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/kmvjZFFLk9DkpamtN95Yr_image.png "Activation Requests List") | **Action** | **Details** | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | \[1] **Summary statistics** | (Available for Litmus Edge Manager version 2.18.0 and later) Shows an optimized summary of the activation requests:
* Waiting for Approval * Processing * Processed * Failed * Rejected * Deactivated | | \[2] **Filter by status** | Allows filtering of activation requests by their status for easier management. | | \[3] **Multiple Select** | Enables selecting multiple activation requests for bulk actions. | | \[4] **View Activation code** | Displays the activation code associated with the selected request. | | \[5] **View Stage: Activation Status** | ****[Activation Request Stage](docId\:CWnZE5vybRzWGrmEC1O_i) | | \[6] **View Stage: Provision Status** | ****[Activation Request Stage](docId\:CWnZE5vybRzWGrmEC1O_i) | | \[7] **Action menu** | - **Approve: **Cannot accept an activation request that's already been rejected. - **Reject: **Cannot reject an activation request that's already been rejected. Cannot reject the following activation status : `ACTIVIATED` / `DEACTIVIATED` - **Retry Failed** - **Delete: **An activation request must be approved or rejected before it can be deleted. | :::hint{type="info"} **Note:** *Summary statistics* is a new feature and is available for Litmus Edge Manager version 2.18.0 and later. ::: # Re-attempt of Activation Code after Rejected Activation Request If an activation request sent by a Litmus Edge instance is rejected by a Litmus Edge Manager, you must first delete the rejected activation request in Litmus Edge Manager before the same Litmus Edge instance can re-attempt the activation code. # Failed Activation Request Once an activation request is sent by a Litmus Edge, approving (activating) it may become unsuccessful. See the following error message for possible resolutions. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/sRXugSvZQxnqNyXvoGFDI_image.png" size="80" width="664" height="198" caption="Error Message during Activation Request" position="center" showCaption="true"} [title] Manage [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ The **Manage** tab for an edge device enables you to: - Stop and restart specific services. - Enable or disable log forwarding to Litmus Edge Manager. - Enable and configure how frequently Litmus Edge Manager polls the edge device for metrics. - Change the token for direct access to the Litmus Edge API. - Update the device from a specific version of Litmus Edge. - Reboot the device. - Download a support bundle for the device. # Stop and Restart Services In the **Service** tab, optionally start and stop the **SSH** service and restart device management, authentication, licensing, and NATS server services. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/4YdndmEEOVKpqXZdiz0j3_image.png) # Edge Device Metrics Sync Interval Edge Device Metrics Sync controls how often LEM polls connected edge devices for metrics data. Adjusting the interval lets you balance reporting frequency against network and performance constraints. A shorter interval provides more granular visibility into edge device behavior. A longer interval reduces network load in bandwidth-limited environments. ### Sync Interval Priority The sync interval can be configured at three levels: device, project and instance. By default, lower-level settings take priority: - The device sync setting overrides the project setting for that device. - The project sync setting overrides the instance setting for all devices in the project. You can also override these priority settings: - Here at the device level by choosing to use the project's metrics sync settings (see [Manage](docId\:BoOFh2bJOlfpger0QymmF) ). - At the project level by choosing to use the instance's metrics sync settings (see [Management](docId\:VzYNhoUsLtjETO0F1aFa1)). :::hint{type="info"} **Note**: **Edge Device Metrics Sync Settings** is available for Litmus Edge Manager version 2.26.1 and later. ::: ### Set the Edge Device Metrics Sync Interval The default interval is 30 seconds with a valid range of `30` to `604,800` seconds (1 week). ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/cNH6gbFLFXvTXEu1BIOUT_image.png" size="80" width="1213" height="463" position="flex-start" darkWidth="1213" darkHeight="463" showCaption="false"} Do any of the following: - Use the **Enable Edge Device Metrics Sync** toggle to enable or disable synchronization of metrics. - Update the sync interval for the device by providing a new value in **Enable Edge Device Metrics Sync**. - To instead use the interval defined by the project, select **Use the project's edge device metrics sync settings**. # API Change the token for direct access to Litmus Edge API. See [Tokens](#) to create an API Token. When creating the API token, you cannot make it read-only from the Litmus Edge user interface. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/QB652oWuSORrC7WF3m4qo_image.png "API sub-tab") # Software View the list of downloaded update files for the edge device. From the **Action menu**, you have the following options: - Manually upgrade the edge device from the update file. - Delete the update file. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/k_Zk-RLHu1G6LzQNaupnF_image.png "Software sub-tab") # Reboot Reboot the edge device. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/tMN0NU4FJYR5MXLSi81Nq_image.png "Reboot sub-tab") # Support Download support bundle files for the edge device. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/vw8kbZe1ThkZ1-0rRCclc_image.png "Support sub-tab") [title] Virtual Machine Installation (VMWare Workstation Player) [path] QuickStart Guide/Installation and Deployments/ You can install the Litmus Edge Manager on a virtual machine using VMWare Workstation Player. The virtual machine that runs Litmus Edge Manager uses the system time of the host environment. To ensure that timestamps of collected data are as universal as possible, we recommend setting the system time of the host environment to the UTC time zone. A typical Litmus Edge Manager virtual file for ESXi deployment adheres to the following naming convention: `.ova`. # Default Login Credentials Refer to the following default login credentials when logging in the first time to different areas of Litmus Edge Manager (LEM). ## Terminal User Interface - **Login/username**: em\_setup - **Password**: edgemanager ## LEM Web UI - **Login/username**: demo - **Password**: demo ## LEM Admin Console - **Login/username**: admin - **Password**: admin ## Keycloak - **Login/username**: kadmin - **Password**: kadmin # Before You Begin - Configure the docker bridge network. By default, this installation allocates the subnet `172.17.0.0/16`. Make sure that this does not conflict with your host environment network configuration. :::hint{type="success"} **Tip**: To reconfigure the docker bridge network, please refer to this [docker guide](https://docs.docker.com/network/bridge/). ::: - Set up proxies to access Litmus Edge Manager behind the company firewall. - Install ESXi v6.7 or higher. See [VMware](https://www.vmware.com/worldwide.html) for more information. - Obtain a valid `.ova` file. Contact Litmus or download the file from the [Customer Portal](https://portal.litmus.io). To use VMWare Workstation Player to install Litmus Edge Manager, you will need to do the following. - Step 1: Install the Virtual Machine (VMWare Workstation Player) - Step 2: Launch the Virtual Machine - Step 3: Log in to the Litmus Edge Manager (LEM) UI - Step 4: Verify Trial License and Register a Litmus Edge Manager License To jump to a specific section, refer to the Table of Contents on the right side and click the corresponding step. # Step 1: Install the Virtual Machine (VMWare Workstation Player) You will first need to install the virtual machine that will run Litmus Edge Manager. **To install the virtual machine:** 1. Start the **VMWare application** (for example, VMWare Workstation 15 Player). The Welcome to *VMware Workstation 15 Player* dialog box appears. 2. Select **Open a Virtual Machine** from the right pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/--PSh-1OhpdmLTjdB2NF9_jvrn5zzccvenozowrz5rvmware-player-open-vm.png "VM Workstation panel") 3. Select the **.ova** file from the file browser, and then click **Open**. The *Import Virtual Machine* dialog box appears. 4. From the *Import Virtual Machine* dialog box, enter the name of the virtual machine in the *Name* field and enter the storage folder path where the virtual machine configuration is stored into the *Storage Path* field. Then, click **Import**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/24xIlR6uzzzPjndNUcj5u_aknjdyaaxjwyggk7o74buvmware-workstation-player-import.png "Import Virtual Machine dialog box") The *VMWare Workstation Play* creates the virtual machine. The *Litmus Edge Manager* device appears in the left pane. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1p2CsoHG1_UIEQqf9GAAY_vmware-workstation-player-success.png" size="80" width="686" height="551" caption="Selecting EdgeManager panel" position="center" showCaption="true"} # Step 2: Launch the Virtual Machine After installing the virtual machine, you will need to launch the virtual machine containing Litmus Edge Manager. **To launch the virtual machine:** 1. From the right pane in the *VMWare Player* application, click **Play virtual machine**. The virtual machine starts up and displays the terminal. 2. Note down the IP as this is required for log in. :::hint{type="success"} **Tip**: You can change your settings using the Terminal User interface (TUI). To log in using the Terminal window, refer to the *Default Login Credentials* section above. ::: # Step 3: Log in to the Litmus Edge Manager (LEM) Web UI After launching the virtual machine, you can then login to Litmus Edge Manager via a browser. **To log in to LEM Web UI:** 1. Open a new incognito browser window and paste the IP address into the URL field. The application initializes, and then the *Log In *screen appears. 2. Enter the default credentials. Refer to the *Default Login Credentials* section above. 3. Change your password to activate your account, and then click **Submit**. The *Litmus Edge Manager* application opens. :::hint{type="info"} **Note**: You must change your password after the first log in. ::: # Step 4: Verify Trial License and Register a Litmus Edge Manager License After the Litmus Edge Manager is successfully installed, it will automatically be installed with a trial license. **To verify the trial license**: 1. From the Navigation panel, select **Settings**. The* Settings* pane appears. 2. From the *Settings* pane, select **Licenses**. 3. From *Licenses*' *Available Licenses* section, view the license list. Initially, the device operates on a trial license. You will eventually need to register a Litmus Edge Manager license once the trial license expires. To register a Litmus Edge Manager license, see [Site and Node-Locked License Overview for Litmus Edge Manager](docId\:Jvibd0MBSj97ZcPDfhab9). [title] Un-Used Licenses [path] Litmus Edge Manager User UI/Product Features/Licenses/ The *Un-Used Licenses* feature provides a summary and options for managing licenses that have not been utilized. Click the **Un-Used Licenses** button to access the *Un-Used Licenses Summary* table. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1UINzdDxHN4N23WmzvwRg_image.png) Refer to the following actions you can take from the *Un-Used Licenses Summary* pane. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6DUBdRA37NjdggvoL12xQ_image.png" size="70" width="992" height="717" position="flex-start" caption="Un-Used Licenses Summary pane" showCaption="true"} | **Action** | **Details** | | ------------------------------------------------------ | ---------------------------------------------------------- | | \[1] **Action menu** | - **Delete:** Allows you to delete anyunusedd licenses. | | \[2] [Upload License CSV](docId:9oVnX_gYLpZzZB_lTGjdO) | Allows you to manage uploading of licenses to be deployed. | [title] Certificates [path] Litmus Edge Manager User UI/Product Features/ :::hint{type="info"} **Note**: The Certificates feature is available for Litmus Edge Manager 2.20.0 and later. ::: The Certificates module in Litmus Edge Manager (LEM) allows you to manage SSL certificates on edge devices. This feature includes a comprehensive summary of all your certificates, sorting and filtering options, and the ability to upload or issue a certificate. # Access Certificates UI **To access the Certificates UI: ** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects *pane appears. 3. Do one of the following: - Click a project from the *Project* pane. The *Dashboard* pane appears for the project. - Click the **Actions** icon for a project, and then select **View. ** The *Dashboard* pane appears for the project. 4. From the Navigation panel, select **Certificates. ** The *Certificates Management* pane appears. Refer to the following actions you can take on Litmus Edge Manager's *Certificates Management *pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/gaki-m5Ska6myNlajI80f_image.png "Certificates Management pane") | **Action** | **Details** | | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | \[1] **View **[Edge Devices](docId\:pqRVYqspADLvoCpHmC3WA)** Statistics** | Display the details of edge devices. | | \[2] **Show filter** | Search by *Description.* | | \[3] **Sorting** | Order the list. | | \[4] **Bulk Actions** | Upload multiple certificates at once. See [Bulk Actions](docId\:F8NGI3rL1DrsvmNF-ATsu) for details. | | \[5] **Action** | - Issue a new certificate - Upload a new certificate - Reset to Edge Default | # Next Steps - [Manage Certificates with DigiCert IoT Trust Manager Integration](docId\:WMPXv5e6D8dZWNeUjiFTE) - [Bulk Actions](docId\:F8NGI3rL1DrsvmNF-ATsu) [title] Activation Request Stage [path] Litmus Edge Manager User UI/Product Features/Activation/Requests/ There are two status indicators next to an activation code. The left indicator displays the activation stage and the right indicator displays the provision stage. The green check mark for the status indicators shows the completion of the Activation Request. You can click a check mark to view the activation steps. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/i2wgRZw9dJwVgI3AMpCev_2023-07-2011-24-47.png "Request Stage") The sequence for *Activation* includes: - Activation request received - Activation request approved - Activation request confirmed - Activation deactivated The sequence for *Provision* includes: - Offline license generated, date generated, and a Details link. - License provisioned to the device, date generated, and a Details link. - Site-Based license server is provisioned to the device, date generated, and a Details link. - Default password policy is provisioned to the device, date generated. - Template provisioned to the device, date generated, if applicable. [title] QuickStart Guide [path] / [title] Apply a Parameterized Template [path] Litmus Edge Manager User UI/Product Features/Templates/ You can apply a parameterized template to one or more edge devices from an open project *Templates*** **pane. When applying a parameterized template, you can apply it to a group of edge devices by clicking the group to show only the edge devices in the selected group.' Review the guide to [Apply a Parameterized Template During Activation](docId\:EPSYMUsWZ9uHWcMWMnyaX). # Additional Details - While applying a parameterized template to an edge device, you can set values for the variables that affect edge devices. - The template variables are changed using the JSON-path and the variable values, and then sent to the edge device using the existing API. # Step 1: Apply a Parameterized Template **To apply a parameterized template: ** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. From the Navigation panel, select **Templates**. The *Templates* pane appears. 4. Click the **Actions** icon next to a parameterized template and select **Apply Template**. The *Apply Template: Select Edge Devices to Appl*y dialog box appears. 5. Select one or more check boxes next to edge devices, and then click **Apply**. The *Set Variables* dialog box appears. 6. From the **Set Variables **dialog box, enter the variable value in the variable field. **Example**: Enter `PLC1` in the **device\_name** field. 7. Click **Apply**. The template is applied to the selected edge devices. # Step 2 : Verifying Template Parameters are Applied to an Edge Device There are many types of possible variables. The following verification procedure is an example. **To verify template parameters are applied to an edge device: ** 1. From another browser tab, log in to Litmus Edge. 2. From the Navigation panel, select **DeviceHub**. The Edge Devices pane appears. 3. Select the device for which the template was applied and ensure that the variables entered in the *Set Variables* dialog box appear correctly. :::hint{type="info"} **Example**: If `device_name` is a variable, make sure that the name for the device is correct. In this case, `PLC1`. ::: [title] Establish an LE-LEM connection from Litmus Edge Manager [path] QuickStart Guide/System Requirements/ An Litmus Edge (LE)-Litmus Edge Manager (LEM) connection is the persistent, secure channel between Litmus Edge and Litmus Edge Manager. It enables centralized remote management of the gateway, including activation, credential provisioning, and forwarding of metrics and events to Litmus Edge Manager. The connection uses two ports for establishment: port 443/TCP for the initial activation handshake, and port 51820/UDP for the permanent bi-directional remote access tunnel. An optional third port (8883/TCP) supports ongoing MQTT data transmission after the connection is in place. :::hint{type="info"} **Note:** For details on the Litmus Edge Manager port customization for this connection, see [Establishing an LE-LEM Connection from Litmus Edge](docId\:WjY18puVyO9mXlW9sAOPc). ::: ## Core Components | Component | Role | | ---------------------------------- | --------------------------------------------------------------------------- | | **Litmus Edge** | The edge gateway. Initiates all connections outbound to Litmus Edge Manager | | **Litmus Edge Manager** | The centralized management platform. Receives and approves connections | | **Port 443/TCP (HTTPS)** | Initial activation channel | | **Port 51820/UDP (Remote Access)** | Permanent bidirectional management tunnel | | **Port 8883/TCP (MQTT SSL)** | Ongoing metrics and event data transmission (optional) | ## Connection Sequence The following steps describe how Litmus Edge initiates and establishes its connection with Litmus Edge Manager. From the Litmus Edge side, the key actions are entering the activation URL and code (step 1) and confirming the permanent connection after it is established (step 7). 1. Litmus Edge user enters activation URL and activation code. See *Step 2: Create an Activation Request in Litmus Edge* section of [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) for details. 2. Litmus Edge attempts to establish an initial connection with inbound port 443/TCP (HTTPS) of Litmus Edge Manager. 3. Litmus Edge Manager receives the connection at its inbound port 443/TCP (HTTPS). 4. Litmus Edge sends an activation request that is received and approved by Litmus Edge Manager. See *Step 3: Approve the Activation Request in Litmus Edge Manager* section of [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) for details. - Litmus Edge sends activation requests on port 443/TCP of Litmus Edge Manager. - Litmus Edge Manager user accepts the activation request in UI. - Litmus Edge Manager responds to the activation request with Litmus Remote credentials. 5. Litmus Edge attempts to establish a permanent connection with inbound port 51820/UDP (Remote Access) of Litmus Edge Manager. 6. Litmus Edge Manager receives the connection at inbound port 51820/UDP (Remote Access). 7. Litmus Edge confirms the permanent connection with Litmus Edge Manager. 8. The permanent connection becomes a secure two-way (bi-directional) connection. Both Litmus Edge and Litmus Edge Manager use Litmus Edge Manager's inbound port 51820/UDP (Remote Access) to communicate with each other. ## Port Requirements: Litmus Edge Manager Configure the following ports: - Open 443 (HTTPS) inbound/Ingress to receive the initial contact from Litmus Edge (activation). - Open 51820 (Remote Access) inbound/ingress to receive the permanent connection from Litmus Edge. - Ensure all outbound communication is available to be able to reach Litmus Edge. ## Data Transmission: Default MQTT SSL Connector After a Litmus Edge-Litmus Edge Manager connection has been established, Litmus Edge Manager can receive [metrics](docId\:XZ4oKukesfg7rDekrLhPU) data or [events](docId\:Qh9PnCUT-G1k_Lz9p4-m3) data (enable event forwarding separately) from a Litmus Edge instance. For Litmus Edge Manager to receive the data, the Litmus Edge instance must enable its Default Generic MQTT SSL Connector ([Integration](docId\:YI-zzNSsMxWw_FXcuiduB)). After the connector is enabled, the Litmus Edge instance attempts to reach a connection at Litmus Edge Manager's inbound port 8883/TCP. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/PYDBfLEHFFyxX3VWZt_lL_le-to-lem.png" size="80" width="1936" height="1129" position="flex-start" darkWidth="1936" darkHeight="1129" showCaption="false"} :::hint{type="info"} **Note:** Ports 443 and 51820 are required for establishing the initial connection. Port 8883 is used for ongoing data transmission when the connection is in place. For additional details about each port, refer to the [Firewall Port Configuration Requirements](docId\:vcocNbL2DlgAGwsJ3YCdm). ::: ## Port Customization For Litmus Edge Manager Open 8883 (MQTT) inbound/ingress to receive the metrics or events data from Litmus Edge. ## Limitations and Considerations - Ports 443 and 51820 must be reachable outbound before activation can begin. The connection cannot be established if either port is blocked. - The MQTT data channel (port 8883) is independent from the management connection and must be explicitly enabled via the Default Generic MQTT SSL Connector. - Litmus Edge does not require any inbound ports for its management connection with Litmus Edge Manager. ## Related Topics - [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) - [Firewall Port Configuration Requirements](docId\:vcocNbL2DlgAGwsJ3YCdm) - [Integration](docId\:YI-zzNSsMxWw_FXcuiduB) [title] Adding ZeroTouch Configuration [path] Litmus Edge Manager User UI/Product Features/Activation/ZeroTouch/ Follow the steps below to add a **Zerotouch** configuration: 1. Click **Add Zerotouch Configuration** on the *Zerotouch* page. The *Add Zerotouch Configuration* dialog box appears. 2. From the **Zerotouch Activation **pane, take the following actions**:** - Fill in the *Name *and *Activation Code*. Then, click **Next**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/7l_ABsnKN_i3TE8-CoiMq_image.png" size="70" width="1673" height="723" position="center" showCaption="false"} 3. **Static IP: **Toggle to Enable/Disable. Accordingly, fill out the following fields to configure Static IP: - **Static IP Address:** Enter the desired static IP address for the device. - **Network Interface:** Select the appropriate network interface for the connection. - **Gateway: **Specify the gateway IP address for network routing. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/AWKb2CPF-ipIuf4gRxWYR_image.png" size="70" width="996" height="661" position="center" showCaption="false"} - (Optional) Enable/Disable *Default Router* option. - Click **Next**. 4. **Docker Containers: **Toggle to Enable/Disable. Display a table to list containers with *Name* and* Run Command *fields. - Click **+ Add **to include a new docker command. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/hxwGl_7Jxnu7NfjO4X2qA_image.png" size="70" width="997" height="453" position="center" showCaption="false"} - Click **Add & Generate** or **Add **to generate the *ZeroTouch TAR* file. 5. A progress message will appear until the configuration is ready. [title] Deployment of Litmus Edge Manager on Google Kubernetes Engine (GKE) [path] QuickStart Guide/Installation and Deployments/ You can deploy Litmus Edge Manager on **Google Kubernetes Engine (GKE)**. # Before You Begin Before you begin, ensure that you have: - A valid Google Cloud Platform (GCP) project with permissions to create and manage Kubernetes clusters. See [Creating and managing projects ](https://cloud.google.com/resource-manager/docs/creating-managing-projects)and [Access control in GKE ](https://cloud.google.com/kubernetes-engine/docs/concepts/access-control)for details. - Familiarity with the [Google Cloud Console ](https://console.cloud.google.com/)and [Cloud Shell](https://cloud.google.com/shell/docs). - The Litmus Google registry credential key file (e.g., `LEM_pull_Key_file.json`) available and uploaded to your working environment To manually deploy Litmus Edge Manager on Google Kubernetes Engine (GKE), you will need to do the following. - Step 1: Setup Your GKE Cluster in Your GCP Project - Step 2: Connect to Your Cluster - Step 3: Execute Kubectl and Helm Commands - Step 4: Access the Litmus Edge Manager UI using the obtained IP address # Step 1: Setup Your GKE Cluster in Your Google Cloud Platform (GCP) Project **To set up your GKE cluster in your Google Cloud Platform (GCP) project:** 1. Log in to your **Google Cloud Console**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Ju4kS3-jpF8fdL3ztALkW_image.png "Google Cloud Console homepage") 2. Select your *GCP project*, then navigate to **Kubernetes Engine **from the main menu. You will land on the *Overview *page of *Kubernetes Engine*. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/VwwpjlPiF6ITwuppBPdtc_image.png "Kubernetes Engine-Overview page") 3. Click on **Clusters **from the side menu and then click **Create** to configure a new Kubernetes cluster. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CIZkjCZhox70QwHsh57xm_image.png "Kubernetes Engine-Clusters page") 4. On the *Create an Autopilot cluster *page, configure the following. 1. **Cluster basics:** - **Switch to Standard Cluster **option (if not already selected). ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/rNIBVf1atvA9j9icxSk_0_image.png "Create an Autopilot cluster ") - Provide a **name **in lowercase (e.g., `gke-cluster`). - Choose an appropriate **region **(e.g., `US-Central`) and select a **Zonal **location type. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/bFFHSRbjJ3eGAF7FhNm5S_image.png "Create an Autopilot cluster ") 2. **Default Pool Configuration:** - Keep the **default-pool **name or modify as needed. - Keep the Number of nodes at **2**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/SYem56SX3QuDFXC0g2RXI_image.png "Default Pool Configuration") - For image type, select **Ubuntu with containerd** (**ubuntu\_containerd**). ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/xhHC56E0b_gwTB79wYwwH_image.png "Default Pool Configuration") - Choose a machine type with at least **2 cores **and **16 GB memory**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0_GXf6OSOkH_3R4shWY59_image.png "Default Pool Configuration") 3. **Network & Security:** - Leave the default settings unless specific adjustments are required. 5. Once configured, click **Create** to initiate the cluster provisioning. Cluster creation may take several minutes. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/eqDCtKQlSiSuJCtdISLg9_image.png "Clusters Configuration") :::hint{type="info"} **Note: **Creating a cluster takes a few minutes, depending on the settings you choose. Please check the status or notifications for the latest information about your cluster. ::: # Step 2: Connect to Your Cluster **Once your cluster is successfully created:** 1. In the *GKE Clusters *page, click on the **Action **button and then select **Connect**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/pI9OXfmlaQTT4nOpwiiLa_image.png "GKE Clusters page") 2. You will be provided with the command-line instructions to connect your local **Terminal **or use the **Cloud Shell **option in GKE. Copy the provided command and run it in your terminal, or click **RUN IN CLOUD SHELL **to open the GKE. For this guide, we use the *Cloud Shell *in GKE. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/znGBBESHvCJxnrZrzCWn9_image.png "Connect to the cluster dialog box ") # Step 3: Execute Kubectl and Helm Commands With your connection established, use the following commands to deploy Litmus Edge Manager from GKE: :::hint{type="info"} **Note: **Keep your **Google Registry Credential Key** file in your workspace, as it's essential for authentication in deployment steps. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/a3n1SB58Iu28bL1-LMHLS_image.png "Cloud Shell") If you don't have the *Google Registry Credential Key *file in your workspace, click the **Action** button in the panel menu. Then select **Upload**. A dialog box will appear, prompting you to upload the file. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/OETZxiiLVYKXMwrBYSaVH_image.png "Cloud Shell") Click on **File **and then **Choose Files** to find the file on your computer. After that, click **Upload** to send it to GKE. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/2pN5MZUYHF27Jb7jtzRql_image.png "Cloud Shell") ::: 1\. Execute the following command to create a **namespace **for Litmus Edge Manager: :::CodeblockTabs shell ```bash kubectl create namespace lem ``` ::: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/VoLc_UC6jfZiDICFiWOIW_image.png "Cloud Shell") 2\. Create **Kubernetes secrets **using *Helm *to securely store credentials. For example: :::CodeblockTabs shell ```bash kubectl --namespace lem create secret docker-registry lem-helm-secret --docker-server=us-east1-docker.pkg.dev \ --docker-username=_json_key --docker-password="$(cat lem-pull-key.json)" --docker-email=any@email.com ``` ::: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/2GWHBOPsi3y12Jd4ghQn5_image.png "Cloud Shell") 3\. Install the Litmus Edge Manager using *Helm*. Adjust the version number (e.g., `2.25.0`) as needed: :::CodeblockTabs shell ```shell helm install lem oci://us-east1-docker.pkg.dev/litmus-public/lem-chart-ga/lem --version 2.25.0 --namespace lem ``` ::: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0wh6NTD-n44OHdEM1YJLs_image.png "Cloud Shell") :::hint{type="info"} **Important Notes:** - The command initiates the pull of the necessary container images. This process may take several minutes. - After the deployment is completed, wait approximately five minutes before applying the Litmus Edge Manager(LEM) URLs and credentials. - Instructions for accessing these URLs and credentials will be printed out for you. ::: 4\. To get the Litmus Edge Manager's **external IP**, run the following where `-nginx` is your service name. ```shell export LEM_URL=$(kubectl get svc litmus-edge-manager -n -nginx -o jsonpath='{.status.loadBalancer.ingress[0].ip}') echo $LEM_URL ``` ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/lqoRUjJavhPTQINGLC5ju_image.png "Cloud Shell") 5\. To get the **Username** and **Password**, run: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/hGv7ZjRBwUU41Yyr0Csci_image.png "Cloud Shell") # Step 4: Access the Litmus Edge Manager UI using the obtained IP address See [Access Web User UI](docId\:w3uHZQ4tSrH7OLjhuLt0A) for details. :::hint{type="info"} **Note:** Obtain the Site License key from your Litmus account executive to activate your license. ::: # Conclusion Litmus Edge Manager is deployed and operational on your GKE cluster. You can now access the manager’s UI using the external IP address and proceed with any additional configuration, such as license activation, via the admin console. Review the below documents to learn more: - [User Profile Administration](docId\:xFOg2xRprqINGA9cLsZB-) [title] Events [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ In the *Events* tab, you can view the events corresponding to a given edge device. Events can be filtered based on severity, component, start date and end date. Events are captured in this pane only when the **Forward Events** toggle is enabled. :::hint{type="info"} **Note**: As of Litmus Edge version 3.11.0, if Forward Events is enabled and the default MQTT connector created for an activated device is disconnected, events will still get pushed to Litmus Edge Manager. For earlier versions, events won't get pushed if the default MQTT connector is disconnected. ::: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/LE1DujwpQxH95WsRdVnR5_image.png "Events tab") The following severity tags can be filtered: - All - Info - Warning - Alert - Error The following components can be filtered: - All - auth - Auth - cc - Integrations - dh - Device Hub - dm - Device Management - mp - Marketplace [title] Step 2: Create an Activation Configuration in Litmus Edge Manager [path] QuickStart Guide/Activate an Edge Device/ Several parameters can be changed for the activation of Litmus Edge devices in the corresponding Litmus Edge Manager installation. It is important to review these options and to carefully implement the correct configuration during the activation of Litmus Edge licenses. An example of a basic activation configuration can be found in [Example: Create a Basic Activation Configuration](docId\:frC4RwI5KUpmwxzqy7k6_). Note that this example demonstrates the implementation in a fairly basic configuration, which might not meet your specific needs. # Overview An activation configuration can be configured with limits, license keys, templates and/or template variables. These configurations are all entirely optional. Some of these configurations have existing default values while others can be left blank. These configurations are all implemented in the first four sub-steps and can be skipped if no additional customization is needed. Generating the details for an activation configuration occurs only in *Step 2g: Save* while retrieving the key details are in *Step 2h: Retrieve Activation Code/URL*. # Before You Begin - If you are using a node-locked license, make sure you have a license key for deployment. To get a license key, contact your Litmus account executive. - If you are using a site-based license, make sure you’ve already applied the license in Litmus Edge Manager. See [License Server Management](docId:5U_hNNsaVs--E5HQJEQ0O). # Step 2a: Navigate to Activation Configuration Follow these initial steps to access the Activation Configuration options. 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Click a project (the project tile) from the Project pane. The *Dashboard* pane for the project appears. 4. From the navigation panel, navigate to **Activation **> **Configuration**. The *Activation Configuration* pane appears. 5. Click the **Add (+)** icon. The *Activation Config List/ NEW* pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/VGN52zMQqHV-5mWZkJyqL_2023-07-1915-57-19.png "The button for adding a new activation configuration.") # Step 2b: Configure Limits You have the option of configuring limits. Specifically, you can configure the number of edge devices, the lease TTL and the expiration date. If no changes are needed, proceed to the next sub-step. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/4SN1XZ4nJ2jciUlGzPYQ1_image.png "Activation Configuration: Limits configuration options") - **Number of edge devices:** Enter the number of devices that will share the activation code. The activation code (created after saving) can be used for multiple edge device activations. - **Lease TTL for identity certificate:** Enter the number of days the identity certificate for the activation will be valid from the day you activate the edge device. - **Expiration Date**: Select the expiration date when the activation code can no longer be used. # Step 2c: Configure Licenses and License Types You have the option of using either a node-locked or a site license. By default, a node-locked license is selected. - A node-locked license associates and attaches a license with a Litmus Edge instance. Use this option for assigning one license to each edge device. - A site license is where Litmus Edge retrieves a license from a Litmus Edge License Server. Use this option to set the license server IP address. See [Site and Node-Locked License Overview for Litmus Edge](docId\:nbX0O6C5ylSh-qVy0sdJc) to learn more. If no changes are needed, proceed to the next sub-step. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/KM04NTBSz0MY4wfoolG0K_image.png "License and license type configuration options") ## Configure a Site-based License Ensure the site-based license has already been applied in Litmus Edge Manager before activating the device. The site license must be created through *Offline activation* in [License Server Management](docId:5U_hNNsaVs--E5HQJEQ0O). ## Configure a Node-locked License You have the option of adding node-locked license keys manually or uploading them in a file. ### Add License Key Manually ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/8SJpgnPCIPBgctC5VgWFu_image.png "Adding node-locked keys manually") **To manually add a node-locked license key**: 1. Click the **Add** icon. The **License Code** field drops down. 2. Enter or paste the license code in the **License key** field. ### Upload License Keys ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6t7eoGQ-voKRVV3RWanHA_image.png" size="80" width="1708" height="156" position="center" caption="Uploading node-locked keys" showCaption="true"} **To upload node-locked license keys**: 1. Click the **Upload** icon. 2. Click **Upload From File**, navigate to the license `.txt` file, and then click **Open**. The licenses appear in the *Licenses* field on separate lines for each license. Provide the licenses as specified below. 3. Click the **Upload** button in the dialog box to confirm the operation. The licenses appear in the *Licenses List* and display **No** in the **In Use **column. Please note the following for uploading node-locked license keys: - Each license must use a separate line in the `.txt` file. - A `.csv` file can be used if you are bulk uploading licenses. - You can also enter each license using a separate line manually without clicking **Upload From File**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/BE6c3rVo1tviknD7__Aem_image.png" size="80" width="773" height="453" position="center" caption="Licenses dialog box" showCaption="true"} # Step 2d: Add Templates You have the option of applying templates when activating a Litmus Edge device. Learn more about [Templates](docId\:Me1x3I4rPT_IIgNPCY1GA). If the Litmus Edge device doesn't need a template, proceed to the next step. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/x2P_b1G24sZ07GZkOT9ht_image.png "Add Templates") **To add at least one template**: 1. From the *Template* section, click the **Add** icon. The *Template Select *dialog box appears. 2. Select one or more templates from the list, and then click **Select**. The selected template appears in the *Templates* list. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/H3R0dkvHOzin-UiqrOz_D_image.png "Template Selection") # Step 2e: Add Template Variables You have the option of applying template variables when activating a Litmus Edge device. To use template variables, you'll need to [Parameterize a Template](docId\:ol2rl-sxp_6Y4ISmGzhXA) first. If the Litmus Edge device doesn't need any template variables, proceed to the next step. ## Add Template Variables Manually ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/szmwiO8X6j_Ff-FiaGsJV_image.png "Adding template variables") **To add at least one template variable manually:** - From the *Template Variables*** **section, click the **Add **icon. The *Add new variable set* dialog box appears. ### Add Template Variables for All Devices ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/VjiaO_6PuhnVHdl7zZTU7_image.png" size="60" width="574" height="338" position="center" caption="Add new variable set dialog box : All devices" showCaption="true"} It is possible to add a template variable set applied to all devices. **To add a template variable set applied to all devices:** 1. From the *Add new variable set*** **dialog box, click the **Variable set type toggle** so that it displays *All Devices*. 2. Click **Add.** The variable set: *All devices* appears in the *Template Variables* list. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/efcDDflykw4ww43enDPCQ_5zrudc58c-uy1k-4hw-rzimage-2.png "Litmus Edge Manager User UI : Activation > Configuration : Activation Config 4/7 Add new variables for All Devices") 3. Click the **Add** icon next to the variable set. A drop-down menu appears, where each line has a separate **Variable Name - Variable Value **pair. 4. In the **Variable Name **field, enter a variable name. 5. In the **Variable Value **field, enter a variable value. ### Add Template Variables for an Individual Edge Device ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/_P1qfcHi3mCThhyYYxppJ_image.png" size="50" width="579" height="342" position="center" caption="Adding template variables for an individual Edge Device" showCaption="true"} **To add a new template variable for an individual edge device:** 1. From the *Add new variable set *dialog box**,** click the **Variable set type** toggle so it displays *Per Edge Device*. 2. In the **Host Name** field, enter the host name for an edge device. To find the host name for an edge device, see *Host Information *in [Configure the Network Settings](docId\:jW2n7vOhntfAgknzoyLQc). 3. Click **Add.** The Variable set: *per Edge Device:* \ appears in the *Template Variables *list. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/cTuOFMlIiEXMjPwhAqKwh_e0wobrnpssfg5w0ajzflimage.png "Add new variables for per Edge Device") 4. Click the **Add** icon next to the variable set. A drop-down menu appears, where each line has a separate **Variable Name - Variable Value **pair. 5. In the **Variable Name **field, enter a variable name. 6. In the **Variable Value **field, enter a variable value. ## Add Template Variables Using .csv File Multiple template variables can be uploaded using a `.csv` file. A sample `.csv` file is available to download from the user interface for customization. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/a43ztvQoMFpG2juZOYL2Z_image.png" size="80" width="1919" height="154" position="center" caption="Upload Template Variables" showCaption="true"} **To add at least one template variable using a .csv file:** 1. From the *Template Variables* section, click the **Upload **icon. The *Upload variable sets* dialog box appears. 2. (Optional) Click the indicated link (titled 'here') to download a sample `.csv` file. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/BkM0sUd2GW3u3597IDNoM_rnvvtynt8mlttxxczigti2023-07-1409-42-42.png" size="50" width="292" height="316" position="center" caption="The relevant dialog box." showCaption="true"} 3. Click** Select File**, navigate to a variable set `.csv` file, and then click **Open**. The selected `.csv` file appears in the *File Name* field. 4. Click **Upload**. The variable sets listed in the `.csv` file appear in the *Variable Sets* list. # Step 2f: Configure Provision Options :::hint{type="info"} **Note**: The* Provision Options* feature is available for Litmus Edge Manager 2.12.0 and later. ::: To apply the [default password policy](docId\:nZxdm63Ip1guJ_mQiN140) during activation, select the *Password Policy* checkbox. If there are multiple password policies, the master default password policy that can't be deleted is implemented. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3D3wsm5y7PhRA1XK-lfR6_image.png" size="80" width="1071" height="102" position="center" caption="Provision Options section" showCaption="true"} After activation, you can update the [default password policy](docId\:CMHGjEOLZn_qu_jlOjdBO) for individual edge devices. # Step 2g: Configure Advanced Settings :::hint{type="info"} **Note**: The *Advanced Settings* feature is available for Litmus Edge Manager 2.11.0 and later. ::: When Litmus Edge Manger (LEM) connects to a Litmus Edge (LE) instance, it uses Remote Access. Remote Access has a parameter `PersistentKeepalive` that you can use to configure how often to send an authenticated empty packet to a Litmus Edge instance for the purpose of maintaining the LEM-LE connection. By default, Remote Access uses 22 seconds. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1yANrjF0Uh79RC7jZ1AuZ_image.png" size="80" width="1905" height="189" position="center" caption="Advanced Settings: Remote Network PersistentKeepalive Interval" showCaption="true"} To set advanced settings, from the **Remote Network Persistent Keepalive** field, enter a number of seconds between 1-25 (both inclusive). # Step 2h: Save When done configuring the Activation Configuration, click** Save**. Once saved, the activation code will then be generated at the *Activation Code* field. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CarewECxIvtf3_TNnHHMA_j8ohulh4be53wsfolialrimage.png "Save button") # Step 2i: Retrieve Activation Code/URL After saving, the activation code will display underneath the *Activation Code* section. This code and the *Activation URL* will be needed when activating a Litmus Edge instance. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/UQf6LsCUz40rhv_P-50-a_j8ohulh4be53wsfolialrimage.png "Retrieve activation code/URL") **To retrieve the activation code/URL**: 1. **Copy to clipboard** the *Activation Code*. It will be needed for activating a Litmus Edge instance. Then, save (paste) the *Activation Code *in a secure location. 2. **Copy to clipboard** the *Activation URL*. It will be needed for configuring a Litmus Edge instance. Then, save (paste) the *Activation URL *in a secure location. # Next Step Use the copied *Activation Code* and *Activation URL* to [Create an Activation Request in Litmus Edge](docId:0AxUENzrqbUXfriiPUYlh). [title] Activation [path] Litmus Edge Manager User UI/Product Features/ The Activation module allows you to provision a connection between an edge device and Litmus Edge Manager. When you select **Activation** from the Navigation panel, the **Configuration** and **Requests** sub-modules appear. You can perform activation provision (zerotouch) for an edge device from these sub-modules. When you add an activation configuration from the Activation Configuration pane, you can create an activation code and make selections for edge devices that use the activation code from Litmus Edge Manager. Additionally, you have the option to enable auto-provisioning, which allows edge devices to configure themselves automatically with the necessary settings when they connect to the network. The Activation Request List pane allows you to approve, reject, or delete an activation configuration from Litmus Edge Manager. # Next Steps The following sub-modules are available for **activation**. - [Configuration](docId\:Jr3PpIPRQ-O49pFdJHDkN) - [Requests](docId:401zhGr_S57O7usKTT79e) [title] Manage a Project [path] Litmus Edge Manager User UI/Product Features/Project List/ After you create a project, the Project List offers a list of actions to manage them. Refer to the following actions you can take on the Litmus Edge Manager User UI's *Project list* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/wIwqQNwX5L1KmL3Gzt4aG_2023-07-2714-12-23.png "Project List") | **Action** | **Details** | | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **View Project Dashboard** | See [LEM Dashboard](docId\:NICP2iziO86MTz4iqR5DP) for details. | | \[2] **Action menu** | - **View**: See [LEM Dashboard](docId\:NICP2iziO86MTz4iqR5DP) for details. - **Edit** - **Delete: **Removing a project removes all related resources and they cannot be restored. | | \[3] **Show filter**/**Hide filter** | Search by project name or description. | | \[4] **Change to Table**/**Module view** | Allows users to switch between different layouts for better project management visibility. | [title] Deploy AI/ML Model [path] Litmus Edge Manager User UI/Product Features/AI/ML Models/ :::hint{type="info"} **Note**: This feature is available for Litmus Edge Manager version 2.22.1 and later. ::: The *AI/ML Models *pane allows the deployment of machine learning models to multiple edge devices at once. # Before You Begin Ensure you do the following: - Have imported a ZIP file that contains the necessary model configurations and parameters. See [Import AI/ML Models](docId\:NejWAOLMno3aSEMjsafyR) for details. **To add an AI/ML model in bulk to your edge device(s):** 1. Click **Bulk Deploy** button from the *AI/ML* *Models *pane. The *Model Deploy Master *dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/yho4U5eH4rNwbS9Lix3x3_image.png" size="80" width="1161" height="612" position="center" caption="AI/ML Models pane" showCaption="true"} 2. From the *Select Devices *pane, select the checkbox next to the edge device(s) you wish to add the models to. Then, click **Next**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/9vIBrYRt8SmoZDllZzIBC_image.png" size="70" width="977" height="395" position="center" caption="Select Devices pane" showCaption="true"} 3. From the *Models *pane, select the model you want to deploy from the list of available models. Then, click **Next**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/pMFCq8lW5HzpBoJKJn2Pk_image.png" size="70" width="976" height="376" position="center" caption="Models pane" showCaption="true"} 4. Review the *Summary* of the target devices and the selected model, and click **DEPLOY** **MODELS**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Qdxmy6f43GDIdQYQ9plfg_image.png" size="70" width="976" height="369" position="center" caption="Review page" showCaption="true"} 5. Once the *Status* has changed to *SUCCESS*, click **FINISH**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/s_1Mct6TQejjEdbd2Pt62_image.png" size="70" width="975" height="369" position="center" caption="Result pane" showCaption="true"} [title] Generate a Report [path] Litmus Edge Manager User UI/Product Features/Licenses/ :::hint{type="info"} **Note**: This feature is available for Litmus Edge Manager version 2.18.0 and later. ::: You can generate a report summarizing license(s) statistics in CSV format via email or export. The generated report will allow you to: - License usage, statuses, and key statistics - View the status of licenses, including total, active, used, expired, or unused - Track activation details - Filter usage and availability in real-time # Before You Begin Ensure you have at least one or more License SKUs. # Generate a Report 1. Click **Generate Report** from the *Licenses Summary *pane. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Y_TZpmD7RA8SDUpZ9xm7S_image.png" size="100" width="1916" height="537" position="flex-start" showCaption="false" indent="2"} 2. To send the license report by email: 1. Select the **Email CSV **option from the drop-down menu. The *Send Report *dialog box appears. 2. Enter the **Email report recipients **with the intended addresses. 3. Click the **SEND **button to dispatch the report. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/zCZA512BaC_ZcpYpmgSJc_image.png" size="70" width="597" height="249" position="flex-start" caption="Send Report dialog box" showCaption="true" indent="3"} :::Paragraph{listStyleType="decimal" listStart="4" indent="2"} The recipients will receive the email below containing the generated report in a **Microsoft Excel **file. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/KXt218gPbagzZyWBU9xdn_image.png" size="70" width="848" height="355" position="flex-start" showCaption="false" indent="3"} 3. To download the license report as a CSV file: 1. Select **Export CSV**. 2. The report downloads as a **CSV file**. The downloaded *CSV* contains the following columns. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/z1YW2TLmLPptVd6tRmEcI_image.png" size="100" width="1920" height="374" position="center" caption="Generated CSV report file" showCaption="true" indent="3"} | Column Name | Details | | ------------------------ | --------------------------------------------------------------- | | **Project ID** | Identifies the specific project the license is associated with. | | **Device ID** | A unique identifier for the device the license is applied to. | | **Device name** | The configured name of the device. | | **Device friendly name** | A more user-readable name for the device. | | **Device MAC address** | The Media Access Control address of the device. | | **License key** | The unique code for the license. | | **SKU** | The Stock Keeping Unit identifying the type of license. | | **Activation date** | The date when the license was activated. | | **Expiry date** | The date when the main license term ends. | | **Feature Expiry Date** | The expiry date for specific features included in the license. | | **Is core** | Indicates whether the license is a core license. | | **Is trial** | Specifies if the license is a trial version. | | **Status** | The current state of the license (e.g., NEW, EXPIRED). | [title] Applications [path] Litmus Edge Manager User UI/Product Features/ The Applications module contains a list of catalogs and applications available to the selected project. Litmus Edge Manager includes a default Marketplace catalog with applications ready to be deployed. # Access Applications UI **To access the Applications UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects *pane appears. 3. Do one of the following: - Click a project from the *Project* pane. The *Dashboard* pane appears for the project. - Click the **Actions** icon for a project, and then select **View. ** The *Dashboard* pane appears for the project. 4. From the Navigation panel, select **Applications. ** The *Applications* pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/eFQfGBqdN9kjWOsdn2DuC_image.png) # Next Steps - [Manage Applications](docId\:MKlVgrbTqgLnK_10E6cXG) - [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw) [title] Step 3: Create an Activation Request in Litmus Edge [path] QuickStart Guide/Activate an Edge Device/ After creating an activation template on Litmus Edge Manager, you will switch to the corresponding Litmus Edge instance. In Litmus Edge, you will proceed to create an activation request. ## Step 3a: Set Data and Device Management Endpoint You will need to set the endpoint that Litmus Edge will use to connect to Litmus Edge Manager. **To set the endpoint:** 1. In a separate browser tab, log in to the Litmus Edge instance you want to activate. 2. From the navigation panel, select **System** > **Device Management**. 3. In the *Litmus Edge Manager Activation *(or *Cloud Management* for Litmus Edge versions earlier than 3.11.0) section's **Data & Device Management Endpoint** field, click **Edit**. Paste the *Activation URL *value you copied from Litmus Edge Manager and then click **Set**. The *Certificate *dialog box appears. 4. Verify that the certificate information is correct and acceptable, then click **Proceed**. The cloud activation URL updates. ## Step 3b: Validate Connection between Litmus Edge and Litmus Edge Manager :::hint{type="info"} **Notes**: - The option to validate the connection is available for Litmus Edge version 3.11.0 and later. - Although port 51820 for remote access cannot be validated, ensure that this port is open on your network's firewall. ::: Once the endpoint is set, you will need to run a validation to ensure that the connection between Litmus Edge and Litmus Edge Manager is successful. To validate the connection, click **Validate**. A dialog displays showing the validation is processing. If the validation is successful, click **Close **and proceed to Step 2c. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/lbmRQaUHbKUNaPmBeB4Zk_image.png" size="70" width="581" height="240" position="center" showCaption="false"} If the validation is unsuccessful, review the error message and recommended steps, and then run the validation again. The Litmus Edge activation will not be successful without a valid connection. ## Step 3c: Create Activation Request After validating the connection, you will send the activation request to Litmus Edge Manager. To create the activation in request. 1. In the **Activation Code** field, paste the *Activation Code* value you copied from Litmus Edge Manager. 2. Click **Activate**. The activation request is sent to Litmus Edge Manager and a notification box appears. # Next Step Proceed to [Approve the Activation Request in Litmus Edge Manager](docId\:rdL1GO82TH_UOLBJRhaW3). [title] Deployment of Litmus Edge Manager on Azure [path] QuickStart Guide/Installation and Deployments/ You can deploy Litmus Edge Manager directly from the Azure Marketplace. Choose between the consumption and site deployment models depending on your licensing preferences and infrastructure requirements. The key differences involve licensing, billing, and access control. :::hint{type="success"} **Important for Cloud Deployment**: Before you activate the license, make sure all hardware or VM configuration steps are complete—including adding or replacing network interface controllers (NICs). Changing the VM hardware configuration after licensing may invalidate your license settings. ::: ## Consumption Model The Consumption Model is designed for organizations that want a fully managed deployment with automatic licensing and usage-based billing. With this model: - Your license is automatically activated when you deploy and is valid for five years from deployment. - Your tag usage is tracked and billed through Azure Marketplace. - Litmus maintains the virtual machine through a managed resource group. - You have limited access to the underlying VM infrastructure. ## Site Model The Site Model gives you full control over your infrastructure and requires you to manage your own licensing. With this model: - You deploy the infrastructure but no license is included. You request a license separately from the Litmus Account team. - Tag consumption is not monitored or billed. - You maintain full control over your virtual machines. Litmus has no access to your environment. ## Comparison of Models | | Consumption Model | Site Model | | ------------------ | -------------------------------------- | ------------------------ | | **License** | Automatic (valid for 5 years | Request from Litmus team | | **Billing** | Usage-based (tags reported to Azure) | Request from Litmus team | | **VM access** | Limited customer access | Full customer access | | **Litmus access** | Full access via managed resource group | No access | | **Tag monitoring** | Tracked and billed | Not monitored | # Before you begin For Site model deployments: - Request a license from the Litmus Account team before deployment For both deployment models: - Ensure you have access to [Azure Portal](https://portal.azure.com/) - Review the [System Requirements](https://docs.litmus.io/edgemanager/quickstart-guide/system-requirements) for sizing guidance - Review the [Firewall Port Configuration Requirements](https://docs.litmus.io/edgemanager/quickstart-guide/system-requirements#mXuhL) - If deploying on an existing network, grant the Network Contributor role on the subnet to the MS App service principal: :::CodeblockTabs{indent="2"} ```azcli az role assignment create \ --assignee "" \ --role "Network Contributor" \ --scope "/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/" ``` ::: :::Paragraph{indent="1"} where: ::: :::Paragraph{listStyleType="disc" indent="2"} `` is the object ID of the user, group, or service principal (for example, principal ID of a managed identity) ::: :::Paragraph{listStyleType="disc" listStart="2" indent="2"} `` is the ID of the Azure subscription that contains the resource group ::: :::Paragraph{listStyleType="disc" listStart="3" indent="2"} `` is the name of the resource group that contains the virtual network ::: :::Paragraph{listStyleType="disc" listStart="4" indent="2"} `` is the name of the virtual network that hosts the subnet ::: :::Paragraph{listStyleType="disc" listStart="5" indent="2"} `` is the name of the subnet to which you assign the Network Contributor role ::: # Deploy Litmus Edge Manager The deployment process is similar for both models. The main difference is which offering you select in the Azure Marketplace. ## Step 1: Find Litmus Edge Manager in Azure Marketplace 1. Log in to [Azure portal](https://portal.azure.com/). 2. Select **Create a resource**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/JUtzESyfuQ673m2AJ3pio_image.png" size="80" width="800" height="217" position="flex-start" showCaption="false" indent="2"} 3. In the **Search services and marketplace bar**, enter `Litmus`. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/9SSjtL6Gz1zB8sBIXWQcB_image.png" size="80" width="800" height="280" position="flex-start" showCaption="false" indent="2"} 4. From the search results, select the consumption or site model: - **Litmus Edge Manager - Consumption Model** for usage-based billing ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/HYnaEGC1BcPRd5w7qBvMN_image.png" size="80" width="1228" height="488" darkWidth="1228" darkHeight="488" position="flex-start" showCaption="false" indent="3"} :::Paragraph{listStyleType="disc" listStart="2" indent="2"} **Litmus Edge Manager - Site Model** for customer-managed licensing ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/I5th17jfx38hS6ag8d4Jq_image.png" size="100" width="1228" height="488" position="flex-start" showCaption="false" indent="3"} 5. Click the card and navigate to [Litmus Edge Manager - Site Model](https://portal.azure.com/#view/Microsoft_Azure_Marketplace/GalleryItemDetailsBladeNopdl/id/litmusautomation1582760223280.litmus_sitebased/selectionMode~/false/resourceGroupId//resourceGroupLocation//dontDiscardJourney~/false/selectedMenuId/home/launchingContext~/%7B%22galleryItemId%22%3A%22litmusautomation1582760223280.litmus_sitebasedsitemodel%22%2C%22source%22%3A%5B%22GalleryFeaturedMenuItemPart%22%2C%22VirtualizedTileDetails%22%5D%2C%22menuItemId%22%3A%22home%22%2C%22subMenuItemId%22%3A%22Search%20results%22%2C%22telemetryId%22%3A%2244813dfe-1489-43d1-a668-877f2f604a8a%22%7D/searchTelemetryId/69cf4d1d-d536-43d5-819d-2c18d0167e46) or [Litmus Edge Manager - Consumption Model](https://portal.azure.com/#view/Microsoft_Azure_Marketplace/GalleryItemDetailsBladeNopdl/id/litmusautomation1582760223280.lem_litmus_azure/selectionMode~/false/resourceGroupId//resourceGroupLocation//dontDiscardJourney~/false/selectedMenuId/home/launchingContext~/%7B%22galleryItemId%22%3A%22litmusautomation1582760223280.lem_litmus_azuredata_tag_per_hour2%22%2C%22source%22%3A%5B%22GalleryFeaturedMenuItemPart%22%2C%22VirtualizedTileDetails%22%5D%2C%22menuItemId%22%3A%22home%22%2C%22subMenuItemId%22%3A%22Search%20results%22%2C%22telemetryId%22%3A%222d07ba25-0421-4148-bcc5-4cad0dedcb2f%22%7D/searchTelemetryId/65b39d51-e71c-4b4b-a9ac-34d1fb266a39). 6. In the **Litmus Edge Manager - Configuration Model** or **Site Model** page, define the following settings: - **Resource Group**: Define a resource group for deployment. - **Region**: Define a region for deployment. - **Size**: See the [System Requirements Documentation](https://docs.litmus.io/edgemanager/quickstart-guide/system-requirements) for minimum & recommended sizing. - **Managed Resource Group**: Select managed resource group from the options. 7. Click **Review + Create**. 8. Review your configuration, then agree to the Terms & Conditions and provide contact information on the next page. 9. Click **Create**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/2gHdDxG9AyN72_Xgf-Nu2_image.png" size="80" width="800" height="236" position="flex-start" showCaption="false" indent="2"} 10. Check the inbound firewall rules in the virtual network once the application is deployed successfully: - **443/tcp:** LEM UI access - **8446/tcp: **LEM admin console UI access - **8883/tcp:** LE to LEM MQTT connection - **51820/udp:** LE to LEM remote access connection 11. Depending on desired network and architecture, you can define specific ranges of IP for sources and destinations. 12. Review all required and optional inbound and outbound Litmus Edge Manager [Firewall Port Configuration Requirements. ](https://docs.litmus.io/edgemanager/quickstart-guide/system-requirements#mXuhL) 13. Navigate back to the **Overview** page. 14. In the essentials section, find the IP address associated to your Litmus Edge Manager instance by Azure. - \[Optional] Configure DNS ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/8rO47jIqTKUKULROT932O_image.png" size="80" width="800" height="365" position="flex-start" showCaption="false" indent="3"} 15. Enter the IP or DNS in a browser to [Access Litmus Edge Manager](docId\:w3uHZQ4tSrH7OLjhuLt0A) web UI. :::hint{type="info"} **Note:** User access to UI will be determined by network & firewall configuration. ::: [title] LEM Dashboard [path] Litmus Edge Manager User UI/Product Features/ The *Dashboard *module is specific to a project. You must open a project before the *Dashboard *module appears. It contains statistics about the whole project. This information is on the operational network and is completely offline. The *Dashboard *module includes the following sections. - **Edge Devices**: Displays the number of connected edge devices and the total number of edge devices for your project. - **Devices**: Displays the number of connected DeviceHub devices and the total number of DeviceHub devices for your project. - **Edge Tags**: Displays the number of DeviceHub tags. - **Failed/Processed Tags**: Displays the rate of failed / processed Edge Tags (tags/minute). This feature is available for Litmus Edge Manager version 2.8.0 and later. - **Incidents***:* Displays the total number of incidents and the total number of active incidents for the project. - **Edge Device Metrics***: *Displays Integration Traffic (message/second), Integration Buffer size (bytes), Processed tags rate (tags/minute), Failed tags rate (tags/minute), Edge Devices CPU Utilization, Edge Devices Memory Used, Edge Devices Network Load, Edge Devices Storage. - **Alerts***:* Lists devices for the project that have alerts, the alert description, event time, and status. # Access Dashboard UI When you select a project, the *Dashboard *appears. **To view the Dashboard**: 1. Log in to *Litmus Edge Manager*. 2. Select a company. The *Projects *pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The *Dashboard *pane appears for the project. - Click the **Actions** icon for a project, and then select **View**. The *Dashboard *pane appears for the project. Refer to the following actions you can take on the Litmus Edge Manager User UI's *Dashboard* pane. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/gl_MVROKsIB2iY1FwowVF_image.png" size="80" width="1920" height="937" position="center" caption="Dashboard 1/2" showCaption="true"} | **Action** | **Details** | | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | | \[1] **View Additional Edge Device Metrics** | Access more detailed metrics related to the performance and status of your edge devices. | | \[2] **View Alert Status** | When you hover over the (!) icon for a selected edge device, a status pops up showing the status and severity. | | \[3] [Edge Device Details](docId\:YwQwD4skuVTwNtcAV5ijs) | Check specific details of a selected edge device | [title] License [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ Upon activation of an edge device, all license information is automatically loaded in the *License *tab. You can view the license and its expiry date, the features included with the license, and the number of allowed devices and tags. The online and offline activation sections for the edge device are included. You can activate a license in online/offline mode from *Device Details*. Refer to the following actions you can take on the Litmus Edge Manager User UI's *Edge Devices Details License* tab. In the following screenshot, a *Site *license has been chosen. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/pB1fUNAkJ1KEtAs5pjlSq_image.png" size="80" width="1920" height="914" position="center" caption="License tab" showCaption="true"} | **Action** | **Details** | | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Select License Type** | Choose between different types of licenses available for the edge device. | | \[2] **Save** | When switching from Node-locked license to a Site license, the added Node-locked licensed will still be installed when switching back. | | \[3] **Reload Features** | Refresh the available features associated with the selected license type. | When *Node-locked* license is selected, the user interface offers a different set of actions. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/v52dTUtqv0Omsr1_C_wnQ_image.png" size="80" width="1920" height="914" position="center" caption="Online License Activation" showCaption="true"} | **Action** | **Details** | | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | \[4] **Reload License** | Retrieve the current license information for the edge device. | | \[5] **Upgrade License** | Attempting to upgrade will change the user interface. [Add/Upgrade a Node-locked License to an Edge Device](docId\:Py-ihVI6wR4flRtMp1KJS) | | \[6] **Remove License** | Delete the current license from the edge device. | | \[7] **Enter Activation Key** | [Add/Upgrade a Node-locked License to an Edge Device](docId\:Py-ihVI6wR4flRtMp1KJS) | | \[8] **Switch to *****Offline License Activation***** tab** | Navigate to the section for activating licenses without an internet connection. | | \[9] **Submit** | You cannot add a new license when a license already exists. You must **Upgrade License **instead. | ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/PyWyXCjdxbvRAXYi4p8ag_image.png" size="80" width="1920" height="914" position="center" caption="Offline License Activation" showCaption="true"} | **Action** | **Details** | | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[10] **Show filter / Hide filter** | Toggle the visibility of filtering options in the license activation section. | | \[11] **Action menu** | - ****[Add](docId\:Py-ihVI6wR4flRtMp1KJS)[/Upgrade](docId\:Py-ihVI6wR4flRtMp1KJS)[ a Node-locked License to an Edge Device](docId\:Py-ihVI6wR4flRtMp1KJS) | ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/8tFgZQ_qeGUE8LODrOn6w_image.png" size="80" width="1920" height="914" position="center" caption="Features and Performance Packs" showCaption="true"} **** | **Action** | **Details** | | ------------------------- | ---------------------------------------------------------------------------------- | | \[12] **Reload Features** | Refresh the list of features and performance packs available for the edge device. | | \[13] **Action menu** | Open the menu to select further actions related to features and performance packs. | [title] Users [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ The **Users** tab provides a central location for controlling user accounts on all your Litmus Edge devices. Here you can edit user details, update passwords, and add, disable, or remove users on edge devices. :::hint{type="info"} **Note:** You can manage local Litmus Edge user accounts only. User management does not apply to externally authenticated users, such as LDAP, Active Directory, or OAuth accounts. ::: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/-ud8QY5-mp-fkytPC9v_X_image.png) To add a user: 1. Click **Add User** on the right. 2. In the **Create User** dialog, provide user details including a strong password and select a user group to assign the user to. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0N5LX3MpDfgZs6I4Yw2--_image.png" size="80" width="1248" height="552" position="flex-start" showCaption="false" indent="2"} 3. Click **Create**. To manage users: 1. Click the **Action** menu for a user. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/HxTdaS1kTT-oP0zQ9XePe_image.png" size="100" isUploading="false" width="1236" height="460" showCaption="false" indent="2"} 2. Do any of the following: - To update user information, click **Edit **and update information in the **Edit User** dialog. - To update the user's password, click **Change Password**. - To disable a user, click **Disable**. The user becomes disabled and can be reenabled later by choosing **Enable** from this menu. - To remove a user from the device, click **Remove** and click **Yes, remove** in the confirmation dialog. [title] Requests [path] Litmus Edge Manager User UI/Product Features/Activation/ The *Requests *sub-module allows you to approve the provisioning for an edge device. # Access Activation > Requests UI **To access the Activation Requests UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The *Dashboard* pane appears for the project. - Click the **Actions** icon for a project, and then select **View.** The *Dashboard* pane appears for the project. 4. From the *Navigation *panel, select **Activation**. The *Configuration* and *Requests* sub-modules drop down. 5. From the navigation panel, select **Requests**. The *Activation Request List* pane appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/LVc3fIMqlQ5KuL2kRmbLM_image.png" size="80" width="1920" height="914" position="center" caption="Activation Requests" showCaption="true"} # Next Steps - [Manage Device Requests](docId\:W-VtSenKG2hitLO-ZXqfR) - [Activation Request Stage](docId\:CWnZE5vybRzWGrmEC1O_i) [title] View Data from a Litmus Edge Instance and/or a Child Device [path] Litmus Edge Manager User UI/Product Features/Edge Devices/ To view data from a Litmus Edge Instance, at least one child device (connected device within the Litmus Edge instance) must be first properly set up. The child device must be connected with tags, and then the tags must be transformed as imported topics inside the Litmus Edge instance's *Default Generic MQTT SSL connector*. This first child connection will facilitate the data connection between a Litmus Edge instance and the Litmus Edge Manager. Additional child device connections from a Litmus Edge instance will append to the Litmus Edge instance's data and also display as additional child devices in Litmus Edge Manager. :::hint{type="info"} **Notes**:   - Viewing a child device's messages works only for standard tags. - If the child device's tag is removed from the Default Generic MQTT SSL connector, the child device is not deleted from the list of available child devices and will still be displayed. ::: # Before You Begin Using Litmus Edge Manager, activate an edge device. See [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) for more details. To use view data from an edge device and/or a child device, you will need to do the following. - Step 1: Connect a Device with Tags in Litmus Edge - Step 2: Set up Default Generic MQTT SSL Connector with Imported Topics in Litmus Edge - Step 3: View Data in Litmus Edge Manager To jump to a specific section, refer to the Table of Contents on the right side and click the corresponding step. # Step 1: Connect a Device with Tags in Litmus Edge Before data can be viewed for a Litmus Edge Instance, a device must be first connected to the instance, and then associated with tags. This allows the connected device's data to be extracted from the Litmus Edge instance. **To connect a device with at least one tag**: 1. [Connect a Device](docId:3eyAfPpweuVmBLCEy17sq) ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/MLeNXHXC5-GNoFPtF3K6A_testdevice.png" size="80" width="1920" height="914" caption="Litmus Edge : DeviceHub > Devices : Newly connected device" position="center" showCaption="true"} 2. [Add Tags](docId:8sE7z3PmRfwL1nmzcwaLX) to the connected device from the previous step. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/5xrCn_yvy1mPh5VyMKvpi_2023-07-2008-59-01.png "Add a tag to a newly connected device") # # Step 2: Set up Default Generic MQTT SSL Connector with Imported Topics in Litmus Edge After a device is connected with tags, the Default Generic MQTT SSL connector must be enabled. Then the generated tags earlier must then be transformed as topics to be immediately imported and enabled into the Default Generic MQTT SSL connector. **To set up Default Generic MQTT SSL connector with at least one imported topic**: **To import the tag into the generic MQTT SSL connector:** 1. Log in to Litmus Edge. 2. Navigate to **Integration**. 3. Click the *generic-mqtt-ssl* connector tile. 4. Click the **Topics **tab. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/RiGXq8U4ibEwXlMqu4VdZ_topics-tab.png" size="70" width="539" height="516" position="center" showCaption="false"} 5. Click the **Import from DeviceHub** tags icon. The *DeviceHub Import* dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/88SwMXPJ-ZlRMlYGiiEL0_import-tags-icon.png" size="80" width="1053" height="483" caption="Import from DeviceHub tags icon" position="center" showCaption="true"} 6. Select the check box to import the tag from the device you created earlier and click **Import**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6KAn2U3ny1gcM2d__EtNi_devicehub-import.png" size="80" width="962" height="272" caption="DeviceHub Import dialog box" position="center" showCaption="true"} 7. Click the **Enable all topics** icon. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/OFsKCxfI-FgSrUhp1ORi9_enable-all-topics-icon.png" size="80" width="1164" height="469" caption="Enable all topics icon" position="center" showCaption="true"} 8. Return to the *Integration *pane and toggle the connect option and confirm the status is `CONNECTED`. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/I2Ops086U4tzxrunFVNlN_connection-toggle.png" size="60" width="367" height="258" caption="Connector connection toggle" position="center" showCaption="true"} # Step 3: View Data in Litmus Edge Manager Once a Litmus Edge instance is connected to Litmus Edge Manager and a device is added to that Litmus Edge instance, you can view data (outbound messages) from that Litmus Edge instance or that instance's child device in the Litmus Edge Manager UI. **To access the data viewing UI in Litmus Edge Manager**: 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Projects *pane. The* Dashboard* pane appears for the project. - Click the **Actions** icon for a project, and then select **View**. The* Dashboard* pane appears for the project. 4. From the navigation panel, select **Edge Devices**. The *Edge Devices* pane appears. ## View Data From Edge Device **To view edge device data**: 1. From *Edge Devices*, click the **ID** of the edge device whose data you want to view. The *Device Details* pane appears. 2. Click the **Raw** tab. The *Raw Data* pane appears. 3. Toggle **Auto-Refresh** at the bottom of the pane. 4. Select the refresh interval from the **Interval **drop-down list. The messages published by the topics you have added to the Generic MQTT-SSL connector in *Step 2: Set Up Default Generic MQTT SSL Connector with Imported Topics in Litmus Edge* appear on the pane. The list of messages is refreshed according to the interval you have selected from the earlier step. ## View Data From Child Edge Device **To view child edge device data**: 1. Click the **Show child devices** icon next to an edge device. The child devices for the edge device drop down. 2. Click the **ID** of the child device whose data you want to view. The selected device's information pane appears. 3. Click the **Explore** tab. The *Explore *pane appears. 4. Toggle **Auto-Refresh** at the bottom of the pane. 5. Select the refresh interval from the **Interval** drop-down list. The topics you have added to the Default Generic MQTT SSL connector in *Step 2: Set Up Default Generic MQTT SSL Connector with Imported Topics in Litmus Edge* appear on the pane. Their **Last Value **and **Updated At** fields refresh according to the interval you have selected in the previous step. 6. To see the list of values a topic has published since it began auto-refreshing, click **Last Value** for that topic. The values appear in the* Edge Device Object value* dialog box, in a tabular format. 7. To display the same data as a chart, select the **Chart** tab. :::hint{type="info"} **Note**: Once a child device's data has been published (and has become viewable) in Litmus Edge Manager, you can visualize this data using Grafana. See [Visualize Child Device Data Using Grafana](docId\:cY2MwkiuvJ2nvNBZhaotC). ::: [title] Import AI/ML Models [path] Litmus Edge Manager User UI/Product Features/AI/ML Models/ :::hint{type="info"} **Note**: This feature is available for Litmus Edge Manager version 2.21.0 and later. ::: You can upload a new model or display available models from *AI/ML Models* page. :::hint{type="warning"} **Note:** You can only upload the models as a **ZIP** file containing a saved model directory with variables, assets, and a .pb (protocol buffer) file. ::: # Before You Begin Ensure to have a ZIP file that contains the necessary model configurations and parameters. **To upload an AI/ML model zip file:** 1. Navigate to *AI/ML Models* pane. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/EN9ecbjfCRYlBWZHQ330e_image.png" size="80" width="1276" height="698" position="flex-start" caption="AI/ML Models pane" showCaption="true"} 2. Click **AI/ML MODELS** drop-down menu and select the **Upload New AI/ML Model** option. The *Upload AI/ML Model* dialog box appears. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/EKQj9l7qtZEJJDI6qhy5Y_image.png" size="80" width="1276" height="503" position="flex-start" caption="AI/ML Models pane" showCaption="true"} 3. Click **Select File** and navigate to select the ZIP file from your local computer. - **File Name: **(Optional) Rename the file if needed. - **Note:** You can only upload the models as a **ZIP** file containing a saved model directory with variables, assets, and a .pb (protocol buffer) file. 4. Click **Upload**. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Jqo4crGXcEIctonCOwewr_image.png" size="30" width="266" height="361" position="flex-start" caption="Upload AI/ML Model dialog box" showCaption="true"} # Next Steps Refer to the following guides for access to example AI/ML solutions. - [Machine Learning Classification Example](https://portal.litmus.io/accelerators/machine-learning-classification?tab=downloads) - [Machine Learning Classification](docId\:hHvgec_PzGfBWVFsyTP23) [title] Multi-Select Mode [path] Litmus Edge Manager User UI/Product Features/Edge Devices/ The Edge Devices module includes a *Groups and Edge Devices* section. You can create and apply a group to selected edge devices from the *Groups *section. Multi-Select Mode is used when you want to perform the same actions to multiple devices from the Edge Devices pane. You can modify the properties, or start, stop and restart services for the selected devices. **To enable multi-select mode:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. - Click the **Actions** icon for a project, and then select **View**. 4. From the Navigation panel, select **Edge Devices**. The *Edge Devices* pane appears. 5. Click the **Multi-Select** icon. Selection boxes appear next to each edge device. 6. Select one or more edge devices in the **Edge Devices** list. You can perform the following available actions for the selected edge devices. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/zIQMXr9eRY_F6-YyavtBR_image.png "Multi-Select Mode") | **Action** | **Details** | | ------------------------------------------------------- | ------------------------------------------------ | | \[1] **Edit Selected Edge Device** | Modify edge device properties and settings. | | \[2] **Manage Edge device(s) Services** | Control services for selected edge devices. | | \[3] [Open Edge Device](docId\:XpURI-8b1QSviQEpNCvzD) | Access and view the selected edge device. | | \[4] [View Edge Metrics](docId\:LN8vukirANWG3gtEM9pA2) | Review performance metrics of edge devices. | | \[5] **Manage Metrics Pulling** | Enable or disable metrics data collection. | | \[6] **Change Password Policy** | Update security policy for edge devices. | | \[7] **Delete Edge Devices(s)** | Remove selected edge devices from the system. | # Edit Selected Edge Devices You can modify the properties for multiple selected edge devices using Multi-Select. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/uBgnFHmh-gxadLfW4eVRY_image.png" size="80" width="1433" height="358" position="center" caption="Edit Selected Edge devices" showCaption="true"} 1. Click **Select Image**, navigate to the image file and click **Open**. The Image file appears in the *Device Image* field. 2. (Optional) In the *Device Description* field, enter a description for the selected edge devices. 3. (Optional) In the *Add device groups *field, enter a group name for the selected edge device. 4. Click **Update**. The image for the selected devices updates to reflect your selection. # Manage Edge Device(s) Services You can modify the properties, or start, stop and restart services for the selected edge devices. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/MiF42p1XPaE0sC3Ewl1c4_image.png" size="80" width="492" height="446" position="center" caption="Manage edge device(s) services" showCaption="true"} - Click the **Start service** icon next to a service. The service starts for the selected edge devices. - Click the **Restart service** icon next to a service. The service for the selected edge devices restarts. - Click the **Stop service** icon next to a service. The services for the selected edge devices stops. # Backup Edge device(s) You can back up multiple edge devices simultaneously. Once backed up, you can navigate to Edge Devices, click the device name you backed up, and navigate to the [Backup](docId\:axfcH6DH6avOvjLq5W7Rz) tab. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/RtrQt8pzANl2wJrCXWziC_image.png" size="80" width="517" height="262" position="center" caption="Edge Devices Backup" showCaption="true"} # Manage Events Forwarding You can apply or disable events forwarding to multiple edge devices. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/GAB2rRW7jVrLGqPmwfqUd_image.png" size="80" width="495" height="239" position="center" caption="Manage Events Forwarding" showCaption="true"} - Click the **Start **icon next to *Forwarding *to apply Events Forwarding to the selected edge devices. - Click the **Stop **icon next to *Forwarding *to disable Events Forwarding for the selected edge devices. # Manage Metrics Pulling You can apply or disable metrics pulling to multiple edge devices. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/wLbeluBTr_y77mrF77oOL_image.png" size="80" width="488" height="201" position="center" caption="Manage Metrics Pulling" showCaption="true"} - Click the **Start **icon next to *Forwarding *to apply Metrics Pulling to the selected edge devices. - Click the **Stop **icon next to *Forwarding *to disable Metrics Pulling for the selected edge devices. # Change Password Policy You can apply a selected password policy to multiple edge devices. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/VJCzNbiq-oyWzHNEIWGYA_image.png" size="80" width="485" height="632" position="center" caption="Change Password Policy" showCaption="true"} From the *Select Password Policy*** **dialog box, select an option from the **Selected Policy **drop-down list. [title] Deployment of Litmus Edge Manager on AWS [path] QuickStart Guide/Installation and Deployments/ You can deploy Litmus Edge Manager (LEM) directly from the Amazon Web Services (AWS) Marketplace. This topic shows how to perform a consumption model deployment. This model is designed for organizations that want a fully managed deployment with automatic licensing and usage-based billing. With this model: - Your license is automatically activated when you deploy and is valid for five years from deployment. - Tag usage by edge devices is tracked against your license and billed through AWS Marketplace. # Before you begin Before you deploy, make sure you: - Have access to [AWS Cloud Console](https://console.aws.amazon.com/console/home) - Review [System Requirements](docId\:vcocNbL2DlgAGwsJ3YCdm) for sizing guidance - Review [Firewall Port Configuration Requirements](docId\:vcocNbL2DlgAGwsJ3YCdm) # Deploy Litmus Edge Manager Follow these steps to deploy Litmus Edge Manager. ## Step 1: Accept the LEM offering in AWS Marketplace 1. On AWS Marketplace, locate the [Litmus Edge Manager - Consumption Model](https://aws.amazon.com/marketplace/pp/prodview-fytq3z5qkhkk4?sr=0-1\&ref_=beagle\&applicationId=AWSMPContessa) offering. Click **View Purchase Options**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ZXkIwKiGbs8eEESxv0kUx_aws-mp-lem-consumption-2026-07-22-20-23-49.png" size="80" isUploading="false" width="2802" height="2378" darkWidth="2802" darkHeight="2378" position="flex-start" link="{"externalHref":"https://aws.amazon.com/marketplace/pp/prodview-fytq3z5qkhkk4?sr=0-1&ref_=beagle&applicationId=AWSMPContessa","docId":"","docAnchorId":"","openInNewTab":true,"noFollow":false}" showCaption="false" indent="2"} 2. Under **Your Offers**: 1. Select the **Available to purchase offers** checkbox under **Offer availability**. 2. In the **Available to purchase offers** section, select the public offer or a private offer if one has been made available to you. 3. Review the offer summary and price details. 4. Click **Next**. A purchase confirmation page displays. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/js1peh3ThOqthPlpr620E_image.png" size="80" isUploading="false" width="2266" height="2130" darkWidth="2266" darkHeight="2130" position="flex-start" showCaption="false"} ## Step 2: Launch LEM as a consumption model Next, launch LEM as a consumption model. 1. In **Launch method**, select **One-click launch from AWS Marketplace**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/PB4t6ZYR4PYrUfcLDM5Bd_image.png" size="80" isUploading="false" width="2722" height="1259" darkWidth="2722" darkHeight="1259" position="flex-start" showCaption="false" indent="2"} 2. In the **Setup** page, confirm setup details. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/skzsaqr-mf2ldzQ4XFYXb_image.png" size="80" isUploading="false" width="2416" height="2087" darkWidth="2416" darkHeight="2087" position="flex-start" showCaption="false" indent="2"} 3. In the **Launch** section, click **Launch** to open LEM. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/DCNr1duR4ckIgpmZ8JT3t_image.png" size="80" isUploading="false" width="2388" height="2078" darkWidth="2388" darkHeight="2078" position="flex-start" showCaption="false" indent="2"} A progress screen displays. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/OBLc206FbknYckEpE3qTt_image.png" size="80" isUploading="false" width="2424" height="1685" darkWidth="2424" darkHeight="1685" position="flex-start" showCaption="false"} ## Step 3: Allow additional ports After deployment, modify security groups to allow additional ports. 1. In EC2, navigate to **Instances**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/EEN9_AR8pNGy6cT5YCdIg_instance-details-ec2-us-east-1-2026-07-22-21-06-00.png" size="80" isUploading="false" width="2746" height="2268" darkWidth="2746" darkHeight="2268" position="flex-start" showCaption="false" indent="2"} 2. Click the **Security** tab. In **Security groups**, click the link to launch the security groups wizard. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/vOafteKyA5bvFGqN4iOoB_ec2-us-east-1-2026-07-22-21-19-38.png" size="80" isUploading="false" width="3433" height="1027" darkWidth="3433" darkHeight="1027" position="flex-start" showCaption="false" indent="1"} 3. In **Security groups**, select a rule to modify. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/bDbL_zBW9P5FHTzSFtKXb_securitygroup-ec2-us-east-1-2026-07-22-21-20-13.png" size="80" isUploading="false" width="3370" height="1098" darkWidth="3370" darkHeight="1098" position="flex-start" showCaption="false" indent="2"} 4. In **Edit inbound rules**, specify ports to open. For example: - **443/tcp:** LEM UI access - **8446/tcp:** LEM admin console UI access - **8883/tcp:** Litmus Edge to LEM MQTT connection - **51820/udp:** Litmus Edge to LEM remote management connection ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/mI63heG57UBNyCXNLibM6_modifyinboundsecuritygrouprules-ec2-us-east-1-2026-07-22-21-21-23.png" size="80" isUploading="false" width="3491" height="1427" darkWidth="3491" darkHeight="1427" position="flex-start" showCaption="false" indent="2"} :::Paragraph{indent="1"} A confirmation page indicates that changes to security groups were successfully applied. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3WOOyeVlx_ErVbAsefmQ-_securitygroup-ec2-us-east-1-2026-07-22-21-21-46.png" size="80" isUploading="false" width="3735" height="1398" darkWidth="3735" darkHeight="1398" position="flex-start" showCaption="false" indent="1"} 5. Enter the IP or DNS in a browser to [Access Litmus Edge Manager](docId\:w3uHZQ4tSrH7OLjhuLt0A). Litmus Edge Manager launches. [title] Add a Company [path] Litmus Edge Manager User UI/Product Features/Company List/ Before you can add Litmus Edge edge devices to Litmus Edge Manager, you must set up the hierarchy under which the Litmus Edge edge devices will exist. You can create as many companies as needed to accomplish the desired hierarchy and separation. :::hint{type="warning"} **Important**: - You must be an administrator to add a new company. See [Assign Admin Privileges ](docId\:xFOg2xRprqINGA9cLsZB-) for more details. - Company names are alphanumeric, with only the underscore (\_), plus (+), percentage (%), and period (.) special characters permitted. - Company names must be unique. - If a company was previously deleted, a new company with the deleted name cannot be created. - By default, a newly created company is only accessible to the owner who created the company. To make a company accessible to other users, you can add a user to a company as a team member. See [Company Settings](docId\:XwUuYveHjgIbb0bYwlwSt) for more information. ::: If no companies exist, you are presented with an opportunity to add a company when you log in. If you are working in a company or project, you can click the **Company List** to select or add a new company. **To add a new company**: 1. Log in to Litmus Edge Manager. 2. From the *Companies* list, click **Add** or **Add new Companies**. (If viewing an existing company, select **Company List** first.) The *Create a company* dialog box appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/OjTbZCm9MVWKbWXCrp65S_2023-08-0112-23-50.png "Add Company icon ") 3. From the *Create a company* dialog box, in the **Name** field, enter the company name. 4. (Optional) In the **Description** field, enter a company description, and then click **Create.** The new company appears in the Companies List in alphabetical order. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3qLa4WMkBUErERdj1KMGQ_r2teflyla5lmmmjqjo6h2image.png "Create a Company dialog box") # Next Steps - Add a Company Team: [Company Settings](docId\:XwUuYveHjgIbb0bYwlwSt) - Add a Company Team Member: [Company Settings](docId\:XwUuYveHjgIbb0bYwlwSt) [title] Configure an Active Directory as a User Federation in Keycloak [path] QuickStart Guide/ You can connect an Active Directory to Keycloak through LDAP (Lightweight Directory Access Protocol) as a User Federation. # Before You Begin You will need an Active Directory to connect to. If needed, follow up with your IT department to create one. # Step 1: Configure Standalone Realm You will first need to configure the default standalone realm with the new LDAP provider that you will create. **To configure the standalone realm:** 1. Log in to Keycloak using the following URL: **https\://\[LEM IP address]/auth/admin**. See [Access Keycloak](docId\:w3uHZQ4tSrH7OLjhuLt0A) to learn more. 2. In the top-left corner, open the drop-down list for the master realm and select **standalone**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/y2t0GoD8v_UcbeqpaocPS_standalone.png" size="80" width="1920" height="728" position="center" caption="Standalone realm" showCaption="true"} 3. In the left-navigation menu, select** User Federation** and click **Add Ldap providers**. The *Add LDAP provider *page displays. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/KZ5eK-n1Py6rJv7WZd2nh_standalone-ldap-provider.png" size="80" width="1920" height="725" position="center" caption="Add Ldap providers option" showCaption="true"} 4. In the *General options* section, enter a display name for the provider and select **Active Directory** as the vendor. After selecting the vendor, the following fields are auto-filled: **Username LDAP attribute** **RDN LDAP attribute** **UUID LDAP attribute** **User Object classes** ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Y8iKFAtIGuw4eO3SGPwsr_general-options.png "General options section") 5. In the *Connection and authentication settings* section, you will need to configure the external AD LDAP server. Enter the following URL: **ldap\://\[AD server IP address]**. Configure the other connection parameters as required. Then, click **Test connection **to confirm the LDAP connection is successful. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/7G7bt1vBx3BKlUpTqprTO_connection-url.png "Connection and authentication settings section") 6. Configure the following settings and click **Test authentication** to confirm they are correct. **Bind type**: Select the type of the authentication method used during the LDAP bind operation: **none **(anonymous LDAP authentication) or **simple **(bind credential + bind password authentication). **Bind DN**: Enter the DN of the LDAP admin. **Bind credentials**: Enter the password of the LDAP admin. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/OcjrwrIYytFlWF7lYhUal_bind-settings.png "Bind settings") 7. In the* LDAP searching and updating* section, configure the **User LDAP filter** field with appropriate LDAP filters. This allows you to restrict users and enhance security and performance. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/UL_V0NfOD6G1dmSf0z5yN_user-ldap-filter.png" size="80" width="1089" height="719" position="center" caption="LDAP searching and updating section" showCaption="true"} 8. Configure the remaining settings as needed and then click **Save**. # Step 2: Confirm Successful Setup After creating the realm, you can test the connection to confirm the Active Directory is successfully set up. **To confirm the setup is successful: ** 1. In the left navigation menu, select **Clients**. Then, click the home URL for **account-console**. The Keycloak account management page opens in a new browser tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/8_LBPJokMywFqP-1_sd1U_account-console.png "Clients page") 2. Click **Sign out **and then click **Sign in**. The Keycloak sign in page displays. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/IEMxkcXu_16fG9ew3im03_sign-out.png "Sign out button") 3. Use the credentials of any user in your Active Directory to sign in. If the login in successful, the user is now authenticated using an Active Directory. 4. Log in again to Keycloak, select **Users**, and confirm that the user you just logged in with is listed. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/EHtQUtWUys2NEgEderDPB_users.png "Users section") [title] User Profile Administration [path] QuickStart Guide/ You can manage your profile using the Keycloak profile application. Before you can manage your profile, you must log in to Litmus Edge Manager and access your user profile, which is located in the top-right corner of Litmus Edge Manager. See [Access to Litmus Edge Manager](docId\:w3uHZQ4tSrH7OLjhuLt0A) to access the Keycloak application the first time. # Access User Profile **To open your user profile**: 1. Log in to Litmus Edge Manager**.** 2. Select a company. The* Projects* pane appears. 3. From the top of the window, click the **User** icon, and then select **Profile**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/TxHpCXyPNi8qDfT4f75oU_username-options.png" size="50" width="316" height="389" caption="User profile drop down menu" position="center" showCaption="true"} The Keycloak profile application opens. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Re0NcWEoKXoafD-R0cjFF_image.png" size="80" width="901" height="459" position="center" caption="Keycloak landing page" showCaption="true"} ## Manage Personal Info You can manage your username and email by clicking **Personal info** from the Keycloak landing page. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/vCrNT6e7HuEw0AcL19nEm_image.png" size="80" width="901" height="459" position="center" caption="Personal info link" showCaption="true"} Update your username and email as needed and click **Save**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/mOYbEuxUrH1BqB1WHqffP_image.png" size="80" width="922" height="552" position="center" caption="Personal info settings" showCaption="true"} ## Manage Account Password You can manage the account password needed to log in to Litmus Edge Manager through the Keycloak application. :::hint{type="info"} **Notes**: - After you change your user account password, you are logged out and you must log in again using your new password. - If two-factor authentication is enabled, you must provide the six-digit code from the authentication application on your phone during log in. ::: To manage your account password: 1. From the Keycloak landing page, click **Signing in**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/bjo78PVyJL5fQQ71aKcas_signing-in-link.png" size="80" width="901" height="459" position="center" caption="Signing in link" showCaption="true"} 2. From the *Signing in* page, click **Update**. The Litmus Edge Manager login screen displays. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/UhkyuutH772qePF4IonwQ_update-password-button.png" size="80" width="1489" height="658" position="center" caption="Update password button" showCaption="true"} 3. Log in to Litmus Edge Manager again with your current credentials. 4. Enter the new password twice and click **Submit**. ## Set up Keycloak Two-Factor Authentication You have the option of setting up two-factor authentication through Keycloak. For additional security, you can configure two-factor authentication (TFA) with a free authenticator application like Google Authentication. Two-factor authentication exceeds standard security practices by requiring more than a username and password for login access. The authenticator software generates a token that expires within 60 seconds. This token provides the additional layer of authentication required for login. ### Before You Begin You must modify your user account and optionally change your user account password using the Keycloak profile application. **To configure two-factor authentication:** 1. From the Keycloak landing page, click **Signing in**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/tlVgPlLqABoAnoJsm7uOQ_signing-in-link.png" size="80" width="901" height="459" position="center" caption="Signing in link" showCaption="true"} 2. From the Signing in page, click **Set up authenticator application**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/XGzV2X-f6JHdPyuG_21yc_set-up-authenticator-application-link.png" size="80" width="1518" height="648" position="center" caption="Set up authentication link" showCaption="true"} 3. Follow the prompts to set up the authenticator application. Once you configure the authenticator, you will see a confirmation message. :::hint{type="info"} **Note**: - Once you set up two-factor authentication, you must use the authenticator application to access your account after entering your username and password. - After you enter the username and password, the login directs you to a screen to enter the 6-digit one-time code generated by the application on your smart phone. ::: ## View Device Activity To view device activity for Litmus Edge Manager, click Device activity from the Keycloak landing page. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/rzyS7FPaTn2gLw_GsVDfw_image.png" size="80" width="901" height="459" position="center" caption="Device activity link" showCaption="true"} You have the option of signing out specific signed-in devices or logging out of all devices. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/2UJ3tv8-o87EMxERSzgrV_image.png" size="80" width="1396" height="704" position="center" caption="Options to sign out devices" showCaption="true"} ## View Application Permissions You can view application permissions by click **Applications**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Rd71V4fqYs2c7WWCVWNlR_image.png" size="80" width="901" height="459" position="center" caption="Applications link" showCaption="true"} Click the arrow for an application to view more information. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/rQlLQY_Io0LorF9B19QUu_image.png" size="80" width="1396" height="704" position="center" caption="Application information" showCaption="true"} # Assign Admin Privileges You can assign admin privileges to a user in your Litmus Edge Manager through the Keycloak admin console. :::hint{type="warning"} **Important:** You must have the Administrator role (*em-admin*) to do the following: - Add or manage a company from your LEM. - Assign Admin roles to other users in your LEM. ::: **To assign admin privileges:** 1. To access the Keycloak admin console, use the URL `https:///auth/admin`. Check the [Access Litmus Edge Manager](docId\:w3uHZQ4tSrH7OLjhuLt0A) for your first-time login details. 2. From the Keycloak Realm drop-down on the left, switch the realm to **standalone**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/-6AbqaLxgW0gDoTvzd0BU_image.png" size="50" width="346" height="396" position="center" caption="Keycloak realm side menu" showCaption="true"} 3. Navigate to *Users *and select the user to whom you want to grant the privileges. 4. Click the **Role mapping** tab and then click the **Assign role** button. 5. Select *em-admin* on the pop-up and click **Assign**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/as3dxER0BjYT-ubRwEbyQ_image.png "Assign roles dialog box") Once completed, log out and log back in on the LEM UI with the user who was just granted the admin privileges. You should now see (*Admin*) next to their name on the top right. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/JnpgOY5jdwGCsFK6MrLtE_image.png" size="50" width="452" height="75" position="center" caption="Admin role assigned to user" showCaption="true"} [title] Virtual Machine Installation (HyperV) [path] QuickStart Guide/Installation and Deployments/ Perform the following steps to deploy Litmus Edge Manager (LEM) on Hyper-V: - Step 1: Create a Gen 1 Virtual Machine using Hyper-V wizard - Step 2: Configure the Virtual Machine - Step 3: Start the LEM Virtual Machine - Step 4: Log in to Litmus Edge Manager Before you begin, download the `.vdhx` image from [portal.litmus.io ](https://portal.litmus.io/)for the LEM version that you want to install. ## Step 1: Create Gen 1 Virtual Machine using Hyper-V wizard Start Hyper-V Manager. 1. Click on the actions pane and select **New** > **Virtual Machine**. The New Virtual Machine Wizard launches. 2. Choose a name and location for the LEM VM. The default location is `C:\Program Data\Microsoft\Windows\Hyper-V\`. 3. In **Specify Generation**, to enable the LEM VM to boot on Hyper-V, select **Generation 2 **as the target VM generation. 4. In **Assign Memory**, specify `16384 MB` as Startup Memory and select **Use** **Dynamic Memory for this virtual machine**. 5. In **Configure Networking**, select **Default Switch**. 6. In **Connect Virtual Hard Disk,** select **Use an existing virtual hard disk** and specify the location for the `.vhdx` image that you download earlier from [portal.litmus.io](https://portal.litmus.io/). Click **Next** and click **Finish**. The newly created VM displays in the list of virtual machines. ## Step 2: Configure the Virtual Machine 1. Click on the newly created VM and select settings on the action pane to configure the VM. 2. Make the following changes on the **Settings** dialog: - **Boot Order**: Select **IDE** as the default boot option. - **Security**: Clear the **Enable Secure Boot** check box. - **Memory**: Ensure the RAM is at least `16384 MB`. Ensure that **Dynamic Memory** is selected. The minimum RAM is at least `10240 MB`. - **Processors**: Set the number of virtual processors to at least `4`. Leave the remaining fields with the default values. - **Network Adapter**: Confirm that **Default Switch** is selected. 3. Click **Apply** and **OK**. The Settings dialog closes. ## Step 3: Start the LEM VM Click **Connect** on the actions pane. In the dialog, click **Start** to start the LEM VM. ## Step 4: Log in to LEM See [Access Litmus Edge Manager](docId\:w3uHZQ4tSrH7OLjhuLt0A) for information on logging in to LEM. [title] Access Litmus Edge Manager [path] QuickStart Guide/ There are multiple methods to log in to Litmus Edge Manager, along with different aspects of the Litmus Edge Manager to access. The following methods and aspects of Litmus Edge Manager are available to log in to: - Access the Terminal User Interface (TUI) - Access the Litmus Edge Manager Admin Console - Access Keycloak - Access the Litmus Edge Manager User UI # Default Login Credentials Refer to the following default login credentials when logging in the first time to different areas of Litmus Edge Manager (LEM). ## Terminal User Interface - **Login/username**: em\_setup - **Password**: edgemanager ## LEM Web UI - **Login/username**: demo - **Password**: demo ## LEM Admin Console - **Login/username**: admin - **Password**: admin ## Keycloak - **Login/username**: kadmin - **Password**: kadmin # Access the Terminal User Interface After your installation, you can log in to the Terminal User Interface (TUI). From the TUI, you can change the settings for your installation. :::hint{type="info"} **Note**: The TUI logs you out if no activity occurs within a few minutes. ::: **To log in to the TUI**: 1. From the installation, make sure that your installation is running. A terminal window is open when the selected installation is running. 2. Click the browser console and select the terminal window for your installation. The Terminal User Interface (TUI) appears. 3. Enter the default credentials. Refer to the *Default Login Credentials* section above. You can perform actions once you are logged in. # Access the Admin Console You must change your password when you log in to the Litmus Edge Manager Admin Console software for the first time. The initial user name and password is set up to create a local user name and password for the administrator. ## Before You Begin - Make sure that the virtual machine and laptop are connected to the same network, or that network communication through routing is established. - To access the software, you must use Google Chrome, Mozilla Firefox, or Apple Safari. The browser must be connected to the same network as the software and devices. - Make sure you have noted the IP address from the virtual machine during installation. :::hint{type="info"} **Notes**: - Only Admins may use the Litmus Edge Manager Admin Console. - Litmus Edge Manager Admin Console uses a self-signed Certificate. This may prompt the browser to display an error message. Follow the browser guidelines for how to bypass a self-signed security error message. See [Browser Access Restrictions](docId\:F_4FUf7kbozItSH_LMXp4) for more information about how to resolve browser access restrictions. - If the login is performed within two to five minutes after booting the Virtual Machine, you may see an initialization screen. Allow time to complete the startup sequence. ::: **To log in to the Admin Console**: 1. From a browser, enter the host IP address, colon, and then enter port 8446. For example `https://xxx.xxx.1.222:8446`. The *log in* screen appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/xz6NorCrleRCUkbaB62oh_image.png" size="70" width="1920" height="957" position="flex-start" caption="Admin Console Login Screen" showCaption="true" indent="2"} 2. Enter the default credentials. Refer to the *Default Login Credentials* section above. 3. Click **Login**. You are prompted to reset the password to your own password after the first successful login. Litmus Edge Manager Admin Console opens in your browser. The dashboard appears by default. :::hint{type="info"} **Notes**: - Do not forget your password. For security reasons, there is no password recovery. If you lose the administrator password, you must reinstall. - You can reset your password at any time. - You can access the software as long as your browser is on the same network as the software and device, even if you do not have an internet connection. ::: # Access Keycloak You must change your password when you log in to the Litmus Edge Manager Keycloak software for the first time. The initial user name and password is set up to create a local user name and password for the user. Litmus Edge Manager uses a self-signed certificate. This prompts the browser to display an error message. Follow the browser guidelines for how to bypass a self-signed security error message. See [Browser Access Restrictions](docId\:F_4FUf7kbozItSH_LMXp4) for more information. ## Before You Begin - To access the software, you must use Google Chrome, Mozilla Firefox, or Apple Safari. The browser must be connected to the same network as the software and devices. - Make sure your personal computing device is able to establish network communication through routing even if it is not connected to the same network. - Make sure you have noted the IP address from the VM during installation. **To log in to Keycloak:** 1. From a browser, enter the host IP address followed by `/auth/admin`. For example: `https://xxx.xxx.2.18/auth/admin`. The log in screen appears. 2. Enter the default credentials. Refer to the *Default Login Credentials* section above. 3. Click **Login**. You are prompted to reset the password to your own password after the first successful log in. Litmus Edge Manager Keycloak opens in another browser tab. The *Realm Settings* pane appears by default. :::hint{type="info"} **Notes**: - Do not forget your password. For security reasons, there is no password recovery. If you lose the administrator password, you must reinstall. - You can reset your password at any time. - You can access the software as long as your browser is on the same network as the software and device, even if you do not have an Internet connection. ::: # Access Web User UI You must change your password when you log in to the Litmus Edge Manager software for the first time. In some cases, you may want to use the terminal user interface (TUI) when you don't have access to a network system. In this case, you can locally connect your keyboard and monitor to the Litmus Edge Manager system and you should be able to access and configure some of the network systems. The initial user name and password is set up to create a local user name and password for the user. Litmus Edge Manager uses a self-signed certificate. This prompts the browser to display an error message. Follow the browser guidelines for how to bypass a self-signed security error message. See [Browser Access Restrictions](docId\:F_4FUf7kbozItSH_LMXp4) for more information. ## Before You Begin - To access the software, you must use Google Chrome, Mozilla Firefox, or Apple Safari. The browser must be connected to the same network as the software and devices. - Make sure your personal computing device is able to establish network communication through routing even if it is not connected to the same network. - Make sure you have noted the IP address from the VM during installation. **To log in to Litmus Edge Manager**: 1. From a browser, enter the host IP address. The log in screen appears. 2. Enter the default credentials. Refer to the *Default Login Credentials* section above. 3. Click **Login**. You are prompted to reset the password to your own password after the first successful log in. Litmus Edge Manager opens in your browser. The Company List appears by default. 4. Click **Add new company** to create a company, or click an existing company. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/pLIqOYX1yJXM8O9La8snv_image.png) [title] Virtual Machine Installation (ESXi) [path] QuickStart Guide/Installation and Deployments/ You can install the Litmus Edge Manager on a virtual machine using VMWare ESXi. The virtual machine that runs Litmus Edge Manager uses the system time of the host environment. To ensure that timestamps of collected data are as universal as possible, we recommend setting the system time of the host environment to the UTC time zone. The virtual machine that runs Litmus Edge Manager uses the same physical network card as the host environment. To ensure that the Litmus Edge Manager can communicate with data sources (edge devices) and are accessed through the Web UI, we recommend that you consolidate your network to ensure that communication can be established. A typical Litmus Edge Manager virtual file for ESXi deployment adheres to the following naming convention: `.ova`. # Default Login Credentials Refer to the following default login credentials when logging in the first time to different areas of Litmus Edge Manager (LEM). ## Terminal User Interface - **Login/username**: em\_setup - **Password**: edgemanager ## LEM Web UI - **Login/username**: demo - **Password**: demo ## LEM Admin Console - **Login/username**: admin - **Password**: admin ## Keycloak - **Login/username**: kadmin - **Password**: kadmin # Before You Begin - Configure the docker bridge network. By default, this installation allocates the subnet `172.17.0.0/16`. Make sure that this does not conflict with your host environment network configuration. :::hint{type="success"} **Tip**: To reconfigure the docker bridge network, please refer to this [docker guide](https://docs.docker.com/network/bridge/). ::: - Set up proxies to access Litmus Edge Manager behind the company firewall. - Install ESXi v6.7 or higher. See [VMware](https://www.vmware.com/worldwide.html) for more information. - Obtain a valid `.ova` file. Contact Litmus or download the file from the [Customer Portal](https://portal.litmus.io). To use ESXi to install Litmus Edge Manager, you will need to do the following. - Step 1: Install the Virtual Machine (ESXi) - Step 2: Log in to the Litmus Edge Manager (LEM) UI - Step 3: Verify Trial License and Register a Litmus Edge Manager License To jump to a specific section, refer to the Table of Contents on the right side and click the corresponding step. # Step 1: Install the Virtual Machine (ESXi) You will first need to install the virtual machine that will run Litmus Edge Manager. **To install the virtual machine:** 1. Start the **VMWare application **and log in. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/mr5EzcIW-n51dBQsfQKHR_wigvenbr1kxswbpqliirfvmware-esxi-login.png "EsXI Login Page") 2. From the *VMWare Navigator* pane, click **Virtual Machines** and then click **Create / Register.** The *New virtual machine* dialog box appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/RNd9ypGDKyQDkvNNYkRYj_wnhw1dldifuju7jc3pfgyvmware-esxi-create.png "Create/Register VM using EsXi VM Navigator pane") 3. Select **Deploy a virtual machine from an OVF or OVA file.** ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/KpF70L8i0Ei1_IwPB_ZQ3_-gyahbwhkuvaufeh3gj4vmware-esxi-deploy.png "Select creation type panel") 4. From the *Select OVF and VMDK files* screen, do the following: - Enter a name in the **Enter a name for the virtual machine** field. - Click the **Click to select files or drag/drop** box, navigate to an OVA file on your hard drive, and then click **Open**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/gSp1SprZYL_4CrH18PjFX_eao45xux4cwcb606ic72rvmware-esxi-select.png "Select OVF/VDMK file panel") - Click **Next.** 5. From the **Select storage** screen, view the information. Select the available datastore and then click **Next**. In this example, the available datastore is `datastore1`. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/e3w9-VTOQSBrFPNFicKWX_twvhblllqu2c9nulpzlovmware-esxi-storage.png "Select storage panel") 6. From the **Deployment options** screen, review the options, and then click **Next**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/MtoFysmkIw7S-Yg0TIOjq_puyci0fo5l747wssaqhshvmware-esxi-options.png "Deployment option panel") 7. From the **Ready to complete **screen, click **Finish**. The *VMWare ESXi browser* includes the new virtual machine. This will begin the import of the OVA file from Step 4.2 and then the virtual machine creation. Progress can be viewed in the *Recent Tasks bar*. A successfully imported message will be shown once complete. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/b5PiTFuFBabFRlJsJ_JBs_7yyemdax3-ocsjfkbbvppvmware-esxi-ready.png "Ready to complete panel") 8. Check the **Result** column in the *Recent Tasks* pane for a **Completed successfully** link. 9. Double-click the new virtual machine name. The *Navigator* pane displays the selected virtual machine name and the *Browser* pane displays details for the new virtual machine. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/x_6Pfw2TolKAtEcM3jvTb_kabgzrszqeofa2hp0y4wyvmware-esxi-details.png "Successfully generated virtual machine ") 10. (Optional) Click **Actions **to open a dropdown menu and click **Edit settings**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Vrj5mno6yZzoc1HU5S02i_umxmoofwwejvvo6sfvstsvmware-esxi-action-edit-settings.png "Actions > Edit Settings option") 11. Configure `CPU`/ `Memory`/ `Hard disk 1`/ `Network Adapter 1` as needed for your particular use case. **Important: **Learn more about the [System and Minimum requirement ](docId\:vcocNbL2DlgAGwsJ3YCdm) for Litmus Edge Manager deployment. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/-VIzckAZgnjFX6cO5d-xJ_gmmurbfcwnutldf3tazyxvmware-esxi-action-edit-settings-options-1.png "Customizing LEM memory/hard disk/network adapter") 12. Click **Save** when you have finished configuring your ESXi Virtual Machine. 13. Click the **Terminal **window. The *Terminal* window opens. 14. Copy the IP address. :::hint{type="success"} **Tip**: You can change your settings using the Terminal User interface (TUI). To log in using the Terminal window, refer to the *Default Login Credentials* section above. ::: # Step 2: Log in to the Litmus Edge Manager (LEM) Web UI After installing the virtual machine, you can then log in to Litmus Edge Manager with a browser. **To log in to LEM Web UI:** 1. Open a new incognito browser window and paste the IP address into the **URL** field. The application initializes, and then the *Log In* screen appears. 2. Enter the default credentials. Refer to the *Default Login Credentials* section above. 3. Change your password to activate your account, and then click** Submit**. The *Litmus Edge Manager* application opens. :::hint{type="info"} **Note**: You must change your password after the first log in. ::: # Step 3: Verify Trial License and Register a Litmus Edge Manager License After the Litmus Edge Manager is successfully installed, it will automatically be installed with a trial license. **To verify the trial license**: 1. From the Navigation panel, select **Settings**. The* Settings* pane appears. 2. From the *Settings* pane, select **Licenses**. 3. From *Licenses*' *Available Licenses* section, view the license list. Initially, the device operates on a trial license. You will eventually need to register a Litmus Edge Manager license once the trial license expires. To register a Litmus Edge Manager license, see [Site and Node-Locked License Overview for Litmus Edge Manager](docId\:Jvibd0MBSj97ZcPDfhab9). [title] Remote Access [path] Litmus Edge Manager User UI/Product Features/ Quite commonly, Litmus Edge Manager resides on network A (open to the internet or moderately protected by a firewall) while edge devices it manages reside on network B (a private network with no internet access). The Remote Access module enables mutual access between Litmus Edge Manager and its edge devices that reside on the different networks. The Remote Access module **Edge Remote Network**. # Access Remote Access UI **To access the remote access UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The *Dashboard* pane appears for the project. - Click the **Actions **icon for a project, and then select **View. ** The *Dashboard *pane appears for the project. 4. From the Navigation panel, select **Remote Access.** The *Remote Access* pane appears. The *Remote Network *pane of Remote Access appears by default. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Kd1wpr_8zZVpPsxUSjvz__2023-07-2109-01-02.png "Remote Access") # Next Steps The following tabs are available for **Remote Access**. - [Edge Remote Network](docId\:VUZktYUgni3Jo9-4Ohs1h) [title] Add a New Project [path] Litmus Edge Manager User UI/Product Features/Project List/ A project represents an initiative, product, or device-management grouping. A project can represent an industrial plant, for example. Litmus Edge Manager supports multiple projects within a company. Projects can isolate management for specific edge devices, collect data contained within the project, and assign user and team roles for data access. A project dashboard provides edge device status visibility. The combination of a company and a project defines a tenant in a multi-tenancy environment. Once you configure a project, the project dashboard becomes the centralized overview of the project on a single page. It shows what services are active on the server side along with a statistical visualization of the messages, number of devices, and alerts. Various project settings can be accessed from the navigation panel at the left of the window. You can add a project from the instructions listed here or from the *Projects* tab of [Company Settings](docId\:XwUuYveHjgIbb0bYwlwSt). **To add a project from the Project List**: 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Click the **Create a project **box. The Create a project dialog box appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/JIKDwLqQjDkGiN4frjTOy_nwcl5-b2sxnae286qdaf-2023-07-1709-42-11-1.png "Add a New Project icon") 4. From the *Create a project* dialog box, enter the following details: - **Name**: The project name must be alphanumeric and cannot include spaces or special characters. - **Description**: (Optional) Enter a description for the project. 5. Click **Create**. The new project appears in the *Projects* pane. If you click the new project, the Company drop-down list at the top of the window changes to reflect the project. For example, **Company-1/Project1**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/l7IHjfzwpwFlI3F0_dwL9_2023-07-1710-02-54.png "Company/Project drop-down list") [title] Incidents [path] Litmus Edge Manager User UI/Product Features/Alerts/ After selecting a project, the Incidents module appears. The Incidents module includes a list of edge devices for which there is an incident. Incidents are generated alerts that are based on triggers. System triggers are preloaded, and user triggers are created in [Alerts](docId\:BWq6oBkuTNZgIJBIgQPBE). The* Incidents* pane includes filters for selection of a group list, state, and date range filters for Opened Before, Opened After, Closed Before and Closed After. You can view an edge device's details by clicking its ID, and view a trigger by clicking on the trigger link associated with an edge device. # Access Incidents UI **To access the Incidents UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The *Dashboard *pane appears for the project. - Click the **Actions** icon for a project, and then select **View**. The *Dashboard *pane appears for the project. 4. From the Navigation panel, select **Incidents**. The *Incidents* pane appears. Refer to the following actions you can take on the Litmus Edge Manager User UI's *Incidents* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/T-aBO_yMCDyJddbci8RVO_jlvwqtdxvzc8kedbc4fqimage.png "Incidents") | **Action** | **Details** | | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | \[1] **Select Opened Before Date** | Choose a date to filter incidents that were opened before this date. | | \[2] **Select Opened After Date** | Choose a date to filter incidents that were opened after this date. | | \[3] **Select Closed Before Date** | Choose a date to filter incidents that were closed before this date. | | \[4] **Select Closed After Date** | Choose a date to filter incidents that were closed after this date. | | \[5] **Select Device Group List** | Filter incidents by selecting a specific group of devices. | | \[6] **Select State** | - All: Display all incidents - Open: Display only open incidents. - Close: Display only closed incidents. | | \[7] **Show filter** / **Hide filter** | Toggle the visibility of filter options. | | \[8] **View** [Edge Device Details](docId\:YwQwD4skuVTwNtcAV5ijs) | You cannot access an edge device if the Litmus Edge Manager can no longer reach Litmus Edge. | | \[9] **View Trigger** | Click to manage and view alert triggers associated with incidents. [Manage Alert Triggers](docId\:ssMqiDTPoBpV95sc3lkaC) | | \[10] **Resolve Incident** | Take action to resolve a selected incident. | [title] Alerts [path] Litmus Edge Manager User UI/Product Features/ Alerts occur when an event triggers an action. You can add actions and triggers in the** Alerts** module that can use events to send notifications. Review [Alerts Guides](docId\:Z6I7f1kbZSHNsn6FZliSe) to learn more about setting up alert triggers. The Alerts module includes three sections. # Incidents The *Incidents* module includes a list of edge devices for which there is an incident. Incidents are generated alerts that are based on triggers. System triggers are preloaded, and user triggers are created in [Alerts](docId\:BWq6oBkuTNZgIJBIgQPBE). The *Incidents* pane includes filters for selection of a group list, state, and date range filters for Opened Before, Opened After, Closed Before and Closed After. # Triggers The Triggers section includes user-defined triggers. A trigger uses an event or a metric to trigger an action, which in turn sends a notification. You can create, view and modify user-defined triggers for the actions listed. An alert occurrence is registered as an incident and is shown in the [Incidents](docId:81uhi0Waj080EuLYceOaf) module. The generated alert appears in the [LEM Dashboard](docId\:NICP2iziO86MTz4iqR5DP) module and the [Events](docId\:Qh9PnCUT-G1k_Lz9p4-m3) tab in *Edge Device Details*. **Alert Options**: - Email - Webhook - Slack - Pagerduty # Notification Settings From the *Notification Settings* section, you can add, modify, and view actions that is used by a trigger. The action sends a notification (Email, Slack, Webhook, Pagerduty) when a trigger is applied. # Access Alerts UI **To access the Alerts UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The *Dashboard *pane appears for the project. - Click the **Actions** icon for a project, and then select **View**. The *Dashboard *pane appears for the project. - From the Navigation panel, select **Alerts**. The *Alerts* pane appears. Refer to the following actions you can take on the *Alerts *pane. The user interface below is for Litmus Edge Manager version 2.22.1 and later. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6HJTc3fIZ5B1qVS39Xy2J_image.png "Alerts") | **Action** | **Details** | | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | \[1] [Incidents](docId\:y_N0TKDBMjriQEBDh-r15) | View and manage generated incident alerts. | | \[2] [Set Up Alert Triggers](docId\:ssMqiDTPoBpV95sc3lkaC) | Create conditions for triggering notifications. | | \[3] [Notification Settings](docId\:XF6jw2A8iuQd4t_rIQin6) | Manage alert notification preferences and actions. | | \[4] **Add New Trigger** | Create a new user-defined alert trigger.[Set Up Alert Triggers](docId\:ssMqiDTPoBpV95sc3lkaC) | | \[5] **Edit Trigger** | Modify existing user-defined alert triggers.[Set Up Alert Triggers](docId\:ssMqiDTPoBpV95sc3lkaC) | | \[6] **Remove Trigger** | Delete a specified alert trigger. | [title] Virtual Machine Installation (ESXi-Hypervisor) [path] QuickStart Guide/Installation and Deployments/ You can install Litmus Edge Manager on a virtual machine using VMWare ESXi - Hypervisor. The virtual machine that runs Litmus Edge Manager uses the system time of the host environment. To ensure that timestamps of collected data are as universal as possible, we recommend setting the system time of the host environment to the UTC timezone. A typical Litmus Edge Manager virtual file for ESXi deployment adheres to the following naming convention: `.ova`. # Default Login Credentials Refer to the following default login credentials when logging in the first time to different areas of Litmus Edge Manager (LEM). ## Terminal User Interface - **Login/username**: em\_setup - **Password**: edgemanager ## LEM Web UI - **Login/username**: demo - **Password**: demo ## LEM Admin Console - **Login/username**: admin - **Password**: admin ## Keycloak - **Login/username**: kadmin - **Password**: kadmin # Before You Begin - Configure the docker bridge network. By default, this installation allocates the subnet `172.17.0.0/16`. Make sure that this does not conflict with your host environment network configuration. :::hint{type="success"} **Tip**: To reconfigure the docker bridge network, please refer to this [docker guide](https://docs.docker.com/network/bridge/). ::: - Set up proxies to access Litmus Edge Manager behind the company firewall. - Install ESXi v6.7 or higher. See [VMware](https://www.vmware.com/worldwide.html) for more information. - Obtain a valid `.ova` file. Contact Litmus or download the file from the [Customer Portal](https://portal.litmus.io). To use ESXi-Hypervisor to install Litmus Edge Manager, you will need to do the following. - Step 1: Install the Virtual Machine (ESXi-Hypervisor) - Step 2: Log in to the Litmus Edge Manager (LEM) UI - Step 3: Verify Trial License and Register a Litmus Edge Manager License To jump to a specific section, refer to the Table of Contents on the right side and click the corresponding step. # Step 1: Install the Virtual Machine (ESXi-Hypervisor) You will first need to install the virtual machine that will run Litmus Edge Manager. **To install the virtual machine:** 1. Start the **VMWare application** (for example, VMWare vSphere 6.7 hypervisor). The *VMWare ESXi* application appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/u77VTOwyXoyIPGtFhh8F1_qx5i3lfd6awrm6jpnlojvmware-esxi-hypervisor-app.png "VMWare ESXI panel") 2. Click **Create/Register VM.** The *New virtual machine *wizard - *select creation type *appears. 3. Click **Deploy a virtual machine from OVF or OVA file**, and then click **Next**. The *New virtual machine* wizard - *select OVF and VMDK files* appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ojinlI-GlWE8m58u4BSnc_fs566bpodjx6vnitvvzaivmware-esxi-hypervisor-deploy.png "Select creation type panel") 4. From the right pane, enter a name in the **Name** field. 5. Select the `.ova` file using Browse or drag and drop the file on the **Select File** field, and then click **Next**. The *New Virtual Machine *wizard - *Select datastore *appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Zs5e2BMAmiQzNAGN1Uqxf_qpfmvpg9vdizkvrf6-kwkvmware-esxi-hypervisor-select-ova.png "Select OVF and VMDK files panel") 6. From the right pane, select the datastore and then click **Next**. (See Note below.) The *New virtual machine* wizard - *Deployment options* appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/s9_HH4AHysHT2sxIMI-T8_kd3o0r-bq3vf-jdbwx93bvmware-esxi-hypervisor-datastore-1.png "Select storage panel") 7. From the right pane, verify that the *VM Network* is set to your main **Network** port group (for example, VM Network). ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/h47-T7uQx6kfitqYUI7wy_envxsx7gtj89im70ghksevmware-esxi-hypervisor-deployment-options-1.png "Deployment options panel") 8. From the same pane, uncheck **Power on automatically**, and then click **Next**. The *New virtual machine* wizard - *Ready to complete* pane appears. 9. Review the settings and then click **Finish**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6fTjHti2zA6HcYhExo5-b_jk0wdfh0jwlfvla91f5vavmware-esxi-hypervisor-finish.png "Ready to complete panel") :::hint{type="info"} **Note**: The datastore selected in Step 6 must have at least 80 GB of free capacity. ::: The virtual machine deploys. The progress of the deployment is indicated at the bottom in the *Recent* tasks display. Deployment may take several minutes. The virtual machine appears in the localhost pane. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ISL62wEOcvyogDdBgZKli_vmware-esxi-hypervisor-localhost.png" size="80" width="747" height="481" caption="Finished Virtual Machine with LEM" position="center" showCaption="true"} The virtual machine starts up and the terminal window displays. :::hint{type="success"} **Tip**: You can change your settings using the Terminal User interface (TUI). To log in using the Terminal window, refer to the *Default Login Credentials* section above. ::: 10\. Note the IP address required for login. # Step 2: Log in to the Litmus Edge Manager(LEM) Web UI After installing the virtual machine, you can then log in to Litmus Edge Manager using a browser. **To log in to LEM Web UI:** 1. Open a new incognito browser window and paste the IP address noted during setup into the **URL** field. The application initializes, and then the *Log In* screen appears. 2. Enter the default credentials. Refer to the *Default Login Credentials* section above. 3. Change your password to activate your account, and then click **Submit**. The *Litmus Edge Manager* application opens. :::hint{type="info"} **Note**: You must change your password after the first log in. ::: # Step 3: Verify Trial License and Register a Litmus Edge Manager License After the Litmus Edge Manager is successfully installed, it will automatically be installed with a trial license. **To verify the trial license**: 1. From the Navigation panel, select **Settings**. The* Settings* pane appears. 2. From the *Settings* pane, select **Licenses**. 3. From *Licenses*' *Available Licenses* section, view the license list. Initially, the device operates on a trial license. You will eventually need to register a Litmus Edge Manager license once the trial license expires. To register a Litmus Edge Manager license, see [Site and Node-Locked License Overview for Litmus Edge Manager](docId\:Jvibd0MBSj97ZcPDfhab9). [title] Open Edge Devices [path] Litmus Edge Manager User UI/Product Features/Edge Devices/ You can open a Litmus Edge device from the *Edge Devices* pane. # Before You Begin - Retrieve login credentials for the edge device you are opening. - Ensure the edge devices version is v3.11.0 or later, as you can not open edge devices for versions earlier than v3.11.0. To open the edge device: - Click the **Open** **UI** icon beside an edge device. - Select **Open** **UI** from the **Action menu** icon next to an edge device. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/EnxzEFL-8GML104zNAtYu_2023-07-1910-01-34.png "Open Litmus Edge UI icon") Opening an edge device from Litmus Edge Manager to access and manage your connected edge devices. You do not need access to public internet to access your edge devices. # Restrictions Access to the edge device is through Litmus Edge Manager. The IP address in the browser is the same as Litmus Edge Manager. [title] Installation and Deployments [path] QuickStart Guide/ Litmus provides several ways to install Litmus Edge Manager: - [Virtual Machine Installation (HyperV)](docId\:dxZoNcSaY6QbU_fMlj3VD) - [Virtual Machine Installation (ESXi)](docId:3u0MhxD2XYsO4hOODNnWD) - [Virtual Machine Installation (ESXi-Hypervisor)](docId:_x0TDyTnSUvHBp7CM1EXU) - [Virtual Machine Installation (VMWare Workstation Player)](docId\:gJIS2HmE_xAy5krtgR1p3) - [Deployment of Litmus Edge Manager on Azure](docId:6Q4G6Hj7U6w60HoKWkVKv) - [Deployment of Litmus Edge Manager from Azure SaaS](docId\:qrr0kd3M3BqTscU0jhz2C) - [Deployment of Litmus Edge Manager on AWS](docId\:Xm1u25lvvYnslJdHfyEio) - [Deployment of Litmus Edge Manager on Azure Kubernetes Service (AKS)](docId:8RhqJWbbMvu1pTv95zfjj) - [Deployment of Litmus Edge Manager on Google Kubernetes Engine (GKE)](docId\:a1gK7SGcEZed0jsb2iuxN) - [Software Update](docId\:hzLOrWMFP3cGa8OvH_njo) [title] Templates [path] Litmus Edge Manager User UI/Product Features/ A template is a JSON file containing configuration settings for a Litmus Edge device. The **Templates **page provides a centralized location for creating, organizing, and deploying these configurations. You can access all templates available for an instance, an open company, or an open project here. You can create a template from an online edge device or upload a template from a file for an edge device after you have selected a company and opened a project. You can upload templates for: - an **instance** from the Admin Console. - a **company** from a file. - a **project** from a file or create one from an edge device. Templates for edge devices can include devices, analytics, flows, and connectors. You can make selections for these categories when creating a template from an edge device. :::hint{type="info"} **Important**: Before you can create a template, you must add one or more online edge devices in **Edge Devices**. ::: Three scopes are defined for a template: - **Instance**: All companies for this Litmus Edge Manager - **Company**: All projects for this company - **Project**: Only this project You can select the scope for a template when you upload. For example, if you upload a template from the **Company** > **Templates** pane, the template is accessible to all the projects for that company. If you upload a template from a **Project **Templates pane, the template is accessible to only that project. When you modify a template, you can modify the scope by selecting **Company **or **Project** in the **Edit Template** dialog box. You can apply, modify, parameterize, download, and remove a template from the Templates pane. # Access Template UI You can access company-level templates and project-level templates. **To access company-level templates**: 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. From the *Navigation *panel, select **Templates**. The *Templates *pane for the company appears. **To access project-level templates:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. From the *Projects *pane, click a project tile. The *Dashboard *pane appears for the project. 4. From the *Navigation *panel, select **Templates**. The *Templates *pane for the project appears. ## Litmus Edge Manager Refer to the following actions you can take on the Litmus Edge Manager User UI's *Templates* pane. The user interface below is for Litmus Edge Manager version 2.11.0 and later. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/WJb-uw_zUozliRx6INHKa_lidbfeimg2onr4btewsmnimage.png "Templates \[Company View]") ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/d9pQ2rPF2w_4HK9adiknN_edft4iukcpye7alfrvo2bimage.png "Templates \[Project View]") | **Action** | **Details** | | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Show filter** | Search by *Description.* | | \[2] **Create Template from device** | At least one Edge device must be connected to use this option. | | \[3] **Load template from file** | Upload a Simple Template (`.json`) or Parameterized Template (`.zip`) | | \[4] [Parameterize a Template](docId\:ol2rl-sxp_6Y4ISmGzhXA) | See link for details. | | \[5] **Actions** | - **(Project-View only) Apply Template: ** - [Apply a Parameterized Template](docId\:nA7fu9L0Lnpo0Ayr7hAOv) - [Apply a Parameterized Template During Activation](docId\:EPSYMUsWZ9uHWcMWMnyaX) - **Edit Template: **Template scope cannot be changed from *Company* to *Project.* - [Parameterize a Template](docId\:ol2rl-sxp_6Y4ISmGzhXA) - **Download Template: **A `.json` file. When downloaded from the Company List Templates UI, the file contains information on all projects for the company. When downloaded from the Project List Templates UI, the file contains information on only the project. - **Delete: **Deleting a template makes it unavailable for users to apply. Download the template prior to removal so it can be re-uploaded if necessary. | | \[6] **View Template Statistics** | | # Next Steps - [Parameterize a Template](docId\:ol2rl-sxp_6Y4ISmGzhXA) - [Apply a Parameterized Template](docId\:nA7fu9L0Lnpo0Ayr7hAOv) - How-to guide: [Apply a Parameterized Template During Activation](docId\:EPSYMUsWZ9uHWcMWMnyaX) [title] Add New Software Update Tasks [path] Litmus Edge Manager User UI/Product Features/Software Update/ Software update tasks are used to upgrade your edge device software. # Before You Begin Ensure the following: - There is an update file available for the update tasks. See [Edge Software Update](docId:3IevluZfOdrXAqOOpVT1n) to learn more. - The Edge devices that will be upgraded are online. - An Edge device is currently not already undergoing an existing software task (update). You cannot create a new software task for an Edge device that is already undergoing an existing software task. # Running Task Properties - Up to 10 running tasks can run in parallel. Additional ones will be queued until a running task completes. - The progress bar will automatically fill up from 0 to 100% without a need to refresh the page. It will automatically by itself refresh every 5 seconds. - A *Software Update Task *will usually take a few minutes to complete. - A *Software Update Task *will automatically timeout after 1 hour. - A *Software Update Task *that disconnects before it finishes could still upgrade and reboot a Litmus Edge instance. This will happen if the Litmus Edge successfully receives the `.upd` file before the disconnect. - Once the task completes, it will be transferred from the *Current (#)* tab to the* History (#) *tab. If the task was successful, the update status will be set to `COMPLETED`. If instead the task failed, the update status will be set to `ERROR`. The workflow and user interface for adding a software task differs slightly based on your version of Litmus Edge Manager. Refer to the correct workflow when reviewing the steps. # Litmus Edge Manager Version 2.15.0 and Later ## Add New Task You can add a software update task from the*** **Software*** **pane by clicking **a new** or the **Add new task **icon. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/767gbEPOTB6vLwiPCrfw2_image.png "Add new task icon") ## Step 1: Select Software You can select the software that will be applied to recipient Edge Devices. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/g0gUUQshP4AJn-D4JX7BY_image.png "Software Update Task UI Step 1: Select Software") To select software, select at least one software package to add and click **Next**. ## Step 2: Select Target Device(s) After selecting software that will be applied to Edge Devices, select the devices that will receive the software. There is no limit on the number of edge devices that can be updated. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/01SJkmPUVeGT0ygUTzE5C_image.png "Software Update Task UI Step 3: Select Target Device(s)") To target devices to apply, select one or more edge devices from the edge device list and click **Next**. ## Step 3a: Schedule Software Task You have several options to schedule the software task. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ZdyKCoM1Wr1j2Kh_cfTtW_image.png "Software Update Task UI Step 3: Schedule Software Job") To schedule the software task, select one of the following options and click **Next**. - **Run now**: Download and install the update immediately. - **Download only**: Download the upgrade file to devices (only for Edge Devices on Litmus Edge version 3.5.0 and later). - **Run on a schedule**: Download immediately (only for Edge Devices on Litmus Edge version 3.5.0 and later) and install the update at a specified time. ## Step 3b: Configure Software Task Schedule If you select **Run on schedule**, select the date and time to run the software task. You have the option to select the checkbox for **Allow delayed upgrade if the download takes long**. - If you don't select this option and the downloading of the file is not completed by the scheduled upgrade time, the upgrade will not occur. - If you select this option and the the downloading of the file is not completed by the scheduled upgrade time, the upgrade will still occur on a delayed schedule. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/S3q6dvpVmQ57q1cP4XeUR_image.png "Run on a schedule options") ## Step 4: Review Software Task Details Review and confirm the details of the software task. Then, click **Finish **to create the task. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/2jwASeH1_z12XTQbotG4Z_image.png "Software Update Task UI Step 4: Review") The software task appears in the list of *Software Update Tasks*. Click the Task ID to view more information on the task. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/yGjuJdCf5g_ilYjQE_am6_image.png "List of Software Update Tasks") ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/rfGRD7CnIFnYo5nKdhBED_image.png "Software Update Task Details") If you need to cancel tasks, see [Cancel Software Update Tasks](docId\:iL8M8kElSD-uOcYbUZSc9). # Litmus Edge Manager 2.14.0 and Earlier ## Add New Job You can add a software update job from the*** **Software*** **pane by clicking **a new** or the **Add new Job** icon. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/XS5lkvbW0sRuwgSDNfwmw_image.png "Add new job icon") ## Step 1: Select Software You can select the software that will be applied to recipient Edge Devices. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/XH9FTahTEzbXPnBT0KEfD_image.png "Software Update Job UI Step 1: Select Software") **To select software**: 1. From the **Software **tab, select at least one software package to add. 2. Click **Next**. ## Step 2: Select Target Device(s) After selecting software that will be applied to Edge Devices, select the devices that will receive the software. There is no limit on the number of edge devices that can be updated. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/9NKEJ14qhkt7S_AeoIbd9_image.png "Software Update Job UI Step 2: Select Target Device(s)") **To target devices to apply**: 1. From the **Targets** tab, select one or more edge devices from the edge device list. 2. Click **Next**. ## Step 3: Run Deploy Before deploying software to a list of Edge Devices, you can review job details before it gets executed. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ZZN_8_jydbSXsRjhYyp4j_image.png" size="80" width="1304" height="892" position="center" caption="Software Update Job UI Step 3: Run Deploy" showCaption="true"} **To deploy jobs to edge devices**: 1. From the *Targets *tab, you have the option to select the **Start job immediately** check box. 2. Click **Save**. The software job appears in the* Software Update Jobs* pane **Current (#)** tab. [title] Bulk Deploy Licenses [path] Litmus Edge Manager User UI/Product Features/Licenses/ :::hint{type="info"} **Note**: This feature is available for Litmus Edge Manager version 2.18.0 and later. ::: The *Licenses *pane allows the deployment of licenses to multiple edge devices at once. # Before You Begin Ensure you do the following: - Have at least one or more License SKUs. - Add an activated edge device to Litmus Edge Manager without a license key. See [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) for more details. **To add a license key in bulk to your edge device(s):** 1. Select the checkbox next to the edge device(s) you wish to add the license key to. 2. Click **Bulk Deploy Licenses** button from the *Licenses Summary* pane. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/9xWVtmr0H2UxF28PW64tC_image.png" size="100" isUploading="false" width="1919" height="542" showCaption="false" indent="2"} 3. From the *License Deploy Master* dialog box, select the checkbox for the* License SKU* and click **NEXT**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/d6-1a2fnQIryMO-hDdjn2_image.png" size="100" width="1533" height="513" position="center" caption="License Deploy Master dialog box" showCaption="true" indent="2"} 4. Review the *Summary* of the target devices and the selected SKU, and click **DEPLOY LICENSE**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/S-ixVUl5f84hzwzzB-wdV_image.png" size="100" width="1533" height="520" position="center" caption="Summary tab for License Deploy Master dialog box" showCaption="true" indent="2"} 5. Once the *Status *has changed to *Success*, click **FINISH**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/mj5ad6fk8mtlah79xll1F_image.png" size="100" width="1532" height="522" position="center" caption="Result tab for License Deploy Master dialog box" showCaption="true" indent="2"} [title] Step 4: Approve the Activation Request in Litmus Edge Manager [path] QuickStart Guide/Activate an Edge Device/ After creating an activation request in Litmus Edge, you will switch back to Litmus Edge Manager to approve the activation configuration request. **To approve the activation configuration request you have created:** 1. From the Litmus Edge Manager navigation panel, select **Activation** > **Requests**. The *Activation Request List* pane appears. 2. Click the **Action** **Menu** icon next to the activation request you have created from earlier, and then select **Approve**. For more information, see the *Approve *option of [Manage Device Requests](docId\:W-VtSenKG2hitLO-ZXqfR) The status for the activation changes. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/oAsUkUj8jBUNaTxHSbdjs_v0kiasnaoef5rjod5iaziimage.png "Approve the activation request in Litmus Edge Manager") | **Action** | **Details** | | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Left green checkmark** | Displays the status of the activation stage. A checkmark indicates that the activation sequence has been received, approved and confirmed. | | \[2] **Right green checkmark** | Displays the status of the provision stage, and indicates that the offline license has been generated, provisioned to the Litmus Edge instance, and the default password policy is also provisioned to the Litmus Edge instance. | | \[3] **Action** | You can approve, reject, retry or delete the activation request from the action menu.
See [Activation Request Stage](docId\:CWnZE5vybRzWGrmEC1O_i) for more details. | # Next Step You can now [Verify Edge Device Activation in Litmus Edge.](docId:_cVCsqXnnzC2XbFcT6bSa) [title] Raw [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ Use the *Raw* tab to monitor any messages that are being sent from the selected edge device. You can filter results by start date and end date, manually refresh the results, and enable auto refresh. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CdItiBsCCH-nQ-J_8Pp5t_1rftkfbtdpibnj4nhndavimage.png "Raw tab") [title] Step 7: Verify Edge Device Activation in Litmus Edge Manager [path] QuickStart Guide/Activate an Edge Device/ In Litmus Edge Manager, view the status for MQTT. See the *Data and Control Status *section in [Edge Devices](docId\:qD0fTbyerVQJxOM5IPApt) for more information. The statuses should be green. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/nx77qZHR3mFaCLLbP_rF-_2023-07-1714-44-55.png "MQTT statuses") If the *Control* status is orange, the Litmus Edge device might not be online or it may not be reachable by the Litmus Edge Manager. If the *Data* status is orange, the **Default Generic MQTT SSL connector** on the Litmus Edge might not have been successfully enabled. # Next Steps After verifying in Litmus Edge Manager that the Edge Device has been activated, you are ready to use Litmus Edge and Litmus Edge Manager in tandem to manage your data. If you would like to learn more details about the configuration options and capabilities of Litmus Edge Manager, view the [Litmus Edge Manager User UI](docId:-sKldTrdGJ49xNOa3yycd) page. If you would like to configure the Litmus Edge Manager client itself, head to the [Litmus Edge Manager Admin Console](docId\:run1qmlV1AuZ9aleqIakZ). [title] Apps [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ The *Apps* tab allows you to view a list of applications deployed for the selected edge device. You can start, stop, and remove an application and get real-time application logs for the edge device. :::hint{type="info"} **Note**: The Litmus Edge Manager must have a marketplace license to use the features in this tab. This requirement and tab visibility was made since Litmus Edge Manager version 2.8.0. ::: Refer to the following actions you can take on the Litmus Edge Manager User UI's *Edge Devices Details Apps* tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/oEj8JWj9VfYBYAPx9aAn9_obped74uajciy6wyrpp5dimage.png "Apps tab") | **Action** | **Details** | | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Show filter / Hide filter** | Search by *Name* and *Parameters* | | \[2] **Action menu** | - **Start** - **Stop** - **Delete: **The application does not need to be stopped first to delete it. This delete operation only terminate the Docker container, but it does not remove the Docker image from the Litmus Edge instance. Ensure, if needed, you also manually delete the Docker image from the Litmus Edge instance as it does occupy significant disk space. See *Delete image* of [Manage Images](docId\:HkWdmj1Xcl6ETf1_A4Xkd) for details. - **Logs** | [title] Manage Security Updates [path] QuickStart Guide/Installation and Deployments/ You can configure Litmus Edge Manager to automatically install security updates. There are several options for enabling automatic updates: - Use Update Manager - Use the unattended-upgrades package - Write your own cron script that calls aptitude - Use cron-apt See [Automatic Security Updates](https://help.ubuntu.com/community/AutomaticSecurityUpdates) from Ubuntu documentation to learn more about setting up these different options. [title] ZeroTouch [path] Litmus Edge Manager User UI/Product Features/Activation/ Zerotouch provisioning allows you to automatically install Edge instance configurations, applications, and Docker files onto multiple devices. The Zerotouch tab allows you to: - Set up a static IP with subnet mask, gateway, and DNS settings. - Add Docker containers to the Zerotouch TAR. - Display an MD5 checksum to verify the file. - Create and download Zerotouch TAR files. - Log actions like file creation and timestamps. :::hint{type="info"} **Important Notes: ** - Large files may take longer to generate. - FAT32 USB drives don’t support files over **4GB**—use **NTFS** or **EXT4** instead. - Once created, Zerotouch configurations cannot be edited. - Zerotouch files are not included in backups but remain available after system updates. ::: # Access Zerotouch UI **To access the Zerotouch UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. From the Navigation panel, select **Activation **>** Zerotouch**. *Zerotouch* tab appears. Refer to the following actions you can take on the Litmus Edge Manager User UI's *Zerotouch *tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/_At9tqgiY_zoAAp1YUmIj_image.png) | **Action** | **Details** | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Name** | Custom label for the configuration. | | \[2] **Activation Code** | The activation code (if used). | | \[3] **Static IP** | Shows if a static IP is set (Yes/No).
* Toggle to Enable/Disable. * Fields for **Static IP Address**, **Subnet Mask**, **Gateway**, and **DNS**. | | \[4] **Containers** | Number of Docker containers included.
* Toggle to Enable/Disable. * Table to list containers with **Name** and **Run Command** fields. | | \[5] **Checksum** | MD5 checksum of the generated TAR file (if available). | | \[6] **Actions** | Buttons to **Edit**, **Generate**, or **Remove** a configuration. | # Next Steps - [Adding ZeroTouch Configuration](docId\:a_ASW0ZnqZrswxDsdKtHf) [title] Info [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ Once an edge device begins sending data to Litmus Edge Manager, it becomes available in the *Info* tab. :::hint{type="info"} **Note**: Some manufacturers do not expose device details to the software. Therefore this information may not be available. ::: You can create device groups which can be used to create group alerts, firmware upgrades, and group jobs. Similar devices can be grouped together, and device group can be mapped to a trigger or multiple jobs. :::hint{type="success"} **Tip**: If data does not display: - Check the device status from the *Edge Devices* pane to see if data is connected. See [Step 7: Verify Edge Device Activation in Litmus Edge Manager](docId\:KC9sqRSng2KSINWL1PfPi). - Check the device information in the edge device. See [Info](docId\:YIwyPagdCmgYF_px_-wgA). ::: Refer to the following actions you can take on the Litmus Edge Manager User UI's *Edge Devices Details Info* tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/M7HBW2lOsZ6ZWuYZ4mbgX_c8nvdkvzpu1kocrnd6wc5image.png "Info tab ") | **Action** | **Details** | | -------------------------------------------------------------------------- | ---------------------------------------------- | | \[1] **Modify Description** | Update the description of the edge device. | | \[2] **Add edge device groups / ** **Remove edge device groups** | Assign or detach device groups from edges. | | \[3] **Change edge device image** | Update the image associated with the device. | | \[4] **Remove edge device image** | Delete the current image from the device. | ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/blCaVD6HWSSlEYLUG5BtZ_image.png" size="80" width="1920" height="852" position="flex-start" caption="Add edge device group" darkWidth="1920" darkHeight="852" showCaption="true"} For an Edge Device's *info* pane's *Add edge device group*, existing group names will appear. You can apply these existing group names to additional devices. [title] Parameterize a Template [path] Litmus Edge Manager User UI/Product Features/Templates/ Templates allow you to preconfigure an edge device's associated devices. Parameterizing a template allows you to specify variables for selected attributes within the template, which can then be applied to specific devices. - You can convert an existing template to a parameterized template. - You can add variables and parameterize a template from the *Templates *pane. - You can preview the template and download the JSON to verify the variables on the template, and then upload the template. Review the [Apply a Parameterized Template During Activation](docId\:EPSYMUsWZ9uHWcMWMnyaX) how-to guide. # Before You Begin - Upload at least one template. See *Load template from file *in [Templates](docId\:Me1x3I4rPT_IIgNPCY1GA). - Determine which attributes in the selected template need a variable. # Additional Details You can do the following: - Apply the parameterized template to an existing device. - Apply the parameterized template to an existing device during activation. - Parameterize **Company**, **Project**,** **or **Instance **templates. - Select any attribute in a template to create a variable. # Access Parameter Template UI 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. From the Navigation panel, select **Templates**. 4. Click the **Actions** icon next to a template which has not been parameterized and select **Parameterize Template**. The *Template Details* pane opens, displaying the *Variables *and *Parameterized Template* panels. Refer to the following actions you can take on the *Templates Details* pane. :::hint{type="info"} **Note**: When parameterizing the country variable, refer to the list of [country codes for ISO 3166](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) when configuring the **Country\_Code**. ::: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/xxo5kJ_wafKecfDIf3IT3_2023-08-0811-46-56.png "Templates: Templates Details") | **Action** | **Details** | | ---------------------------------------- | ---------------------------------------------------------- | | \[1] **Show filter** | Search by *Name*, and *Description* | | \[2] **Add variable** | Add a new variable to the selected template. | | \[3] **Action menu** | - *Edit* - *Delete* | | \[4] **Edit variable** | Modify an existing variable within the template. | | \[5] **Expand Template Variables ** | Expand the section to view all template variables. | | \[7] **Preview Template** | Preview the template to review its structure and contents. | | \[8] **Delete parameterized template** | Delete the selected parameterized template. | # More On Edit variable ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CrKyXloFcqtmGzGSDWT-X_image.png" size="80" width="401" height="360" caption="Edit variable 1/2" position="center" showCaption="true"} | **Action** | **Details** | | ------------------------- | -------------------------------------------------------------- | | \[12] **Select Variable** | Select a variable to edit from the list of existing variables. | | \[13] **Done** | Confirm the editing process is complete. | ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/TT-iuGxJp_d1qXczBxsZk_image.png" size="80" width="432" height="363" caption="Edit variable 2/2" position="center" showCaption="true"} | **Action** | **Details** | | ------------------------------------- | ------------------------------------------------------------ | | \[14] **Revert to the default value** | Revert the selected variable to its default value if needed. | [title] Getting Started [path] QuickStart Guide/ Before you can begin, you must install Litmus Edge Manager using the VMWare ESXi application, and then launch the new virtual machine to open the Terminal User Interface (TUI). This allows you to view the IP address needed to open the virtual machine from a web browser. There are three ways to install Litmus Edge Manager: - [Virtual Machine Installation (ESXi)](docId:3u0MhxD2XYsO4hOODNnWD) - [Virtual Machine Installation (ESXi-Hypervisor)](docId:_x0TDyTnSUvHBp7CM1EXU) - [Virtual Machine Installation (VMWare Workstation Player)](docId\:gJIS2HmE_xAy5krtgR1p3) You can also deploy from the Azure Marketplace or manually from Azure: - [Manual Deployment from the Azure Marketplace](docId\:Hodycn_1Qro4qF-uZOuvH) - [Deployment Using an Azure Template](docId\:SNAMY2lsE5bNA1QBN4pA_) After your installation, you can log in to the Litmus Edge Manager Admin Console. See [Access to Litmus Edge Manager](docId\:w3uHZQ4tSrH7OLjhuLt0A) for more information. The Litmus Edge Manager Admin Console can be accessed at the host IP address using port `8446`. For example, `https://x.x.x.x:8446`. The installation gives a one-time password for your first login. You must reset this password. See [Access to Litmus Edge Manager](docId\:w3uHZQ4tSrH7OLjhuLt0A)  for more information. :::hint{type="success"} **Tip**: You can change your settings using the Terminal User interface (TUI). To log in using the Terminal window, use the following credentials: username: `em_setup` password: `edgemanager` ::: [title] Project List [path] Litmus Edge Manager User UI/Product Features/ You can visualize and organize where an edge device fits into the overall architecture. The second level of the Hierarchy is called **Projects**. Projects are used to administer most of the setup of the Litmus environment. Options can be a division, country, region, plant, project or team. These names are based on how granular the setup has to be or how you understand your own hierarchy. The *Projects *pane displays all the projects for the selected company in tile or list format. Selecting a listed project from the *Projects *pane opens multiple sections in the navigation where you can configure and perform tasks for the selected project. :::hint{type="info"} **Note:** A warning banner displays when available disk space falls below a specified thresold. In this case, click **Details** to view further information and to access a link to Litmus Edge Manager Admin Console. ::: When you are working in a module for a project, Litmus Edge Manager remembers after you log out so the last module in the project you worked on appears when you log in. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/b-SYkNBJMD3uv_UbYJeHD_2023-08-0114-59-55.png "Project List") # Next Steps The following operations are available for **Project List**: - [Add a New Project](docId\:pfNzvF07t2woIpl4azl5_) - [Manage a Project](docId\:fDGdpwQ1NeccDqw3TQKrV) - [Manage Multiple Teams and Members](docId\:wuZwvesh2sg-Er9FjK6OP) [title] MQTT [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ The *MQTT* tab displays the Data Topic for an edge device to which you can subscribe. See [About MQTT](docId\:gj_KczBg9VvhQcZIGCmW9) for more info about MQTT. :::hint{type="info"} **Notes**: - The `Connected` state in the *MQTT* tab indicates that the browser is connected to the Litmus Edge Manager MQTT server with your edge device's configuration settings (username, password, MQTT host), and that you have the correct edge device settings configured. - The connection status of the physical device can be found in the Devices list. ::: Refer to the following actions you can take on the Litmus Edge Manager User UI's *Edge Devices Details MQTT* tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/MVS6lPiKqFl1t2VQuqf2r_2023-07-2010-58-06.png "MQTT tab") | **Action** | **Details** | | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Modify Data Topic Name** | Change the name of the data topic for the edge device. | | \[2] **Copy Data Topic Name** | Duplicate the current data topic name to the clipboard. | | \[3] **Select Quality of service (QoS)** | Choose the level of service for message delivery: 0, 1, or 2. | | \[4] **Subscribe**/**Unsubscribe** | Start or stop receiving messages from the selected data topic; note that messages will be unavailable if you navigate away from the MQTT tab. | [title] Step 1: Verify Litmus Edge- Litmus Edge Manager Compatibility [path] QuickStart Guide/Activate an Edge Device/ Refer to the following table to review which versions of Litmus Edge and Litmus Edge Manager are compatible. | **Litmus Edge version (right)** | **3.0.x** | **3.1.x** | **3.2.x** | **3.3.x** | **3.5.x** | **3.11.x** | **3.16.x** | **4.0.x** | | --------------------------------------- | --------- | --------- | --------- | --------- | --------- | ---------- | ---------- | --------- | | **Litmus Edge Manager version (below)** | | | | | | | | | | **2.x** | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | If your Litmus Edge and Litmus Edge Manager versions are compatible, you can proceed with [Step 2: Create an Activation Configuration in Litmus Edge Manager](docId\:vVZ99_j_TGxX6b9-Y9f8L). [title] Software Update [path] QuickStart Guide/Installation and Deployments/ :::hint{type="warning"} **Important**: For a seamless upgrade experience, you must follow the correct upgrade path. Skipping a significant LTS version may cause issues with the upgrade process. If you are currently on any version from 2.16.0 to 2.16.3, you must first upgrade to version 2.16.4. Then you can upgrade directly to the latest LTS version. ::: The *Upgrade *module allows you to upgrade software versions of Litmus Edge Manager. The Upgrade Components pane provides you with all the tools needed to manage updates and upgrades for the Litmus Edge Manager. # Upgrade Path When upgrading Litmus Edge Manager, you **must **include 2.16.4 in your upgrade path. **Follow this upgrade path:** Earlier Litmus Edge Manager version > 2.16.4 > Latest Litmus Edge Manager version. *** There are three sections on the *Upgrade *page. - **Current Version:** View the current Litmus Edge Manager version, the date and time it was applied, and the modules available for the version. - **Software Update Files: **View uploaded Litmus Edge Manager versions, the date and time they were uploaded, the version size and encryption for the uploaded version. You can delete an uploaded version or use it to upgrade your current version. - **Upload**: Upload a `.upd` file. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/u9DuD58tg05MThkQCZWax_image.png) ## Current Version You can view the details for the current version of Litmus Edge Manager. In this section you can view the following: - The version, date, and time of installation. - Components and build. ## Software Update Files :::hint{type="info"} **Note**: For Litmus Edge Manager version 2.15.0 and earlier, the section is named *New versions*. ::: :::hint{type="warning"} **Important**: For a seamless upgrade experience, you must follow the correct upgrade path. Skipping a significant LTS version may cause issues with the upgrade process. If you are currently on any version from 2.16.0 to 2.16.3, you must first upgrade to version 2.16.4. Then you can upgrade directly to the latest LTS version. ::: You can upload a new update file or view the details for available update files, including the file's SHA256 checksum(SHA256). You can view: - The version, date, and time of installation. - Components and build. Furthermore, you can: - Delete the update file. - You will be prompted with a* Removal Confirmation *dialog box before deleting the upgrade file. - Upgrade to file's version. - If you are not on Litmus Edge Manager version 2.16.4, you must upgrade to the latest LTS version or above before making any further upgrades. - If you choose to upgrade to Litmus Edge Manager 2.10.2 or earlier, the [Marketplace: Catalogs and Applications](docId\:gqoGt_Szm8rz9UdPhl2NL) feature may not operate properly. You will need to [upgrade the Docker version to 23.0.5 or later](https://docs.docker.com/engine/install/ubuntu/), followed by a Litmus Edge Manager reboot as a workaround. - You cannot downgrade to the same or lower version. - If during the upgrade, the connection is lost and regained, the upgrade would have to be restarted. It will not automatically continue once the connection is regained. - The **Upgrade Log **button appears after the upgrade process has started. - Expand the pane to view detailed information about the new version. ## Upload You can upload an `.upd` file from your local machine or from a URL. [title] Litmus Edge Manager User UI [path] / The Litmus Edge Manager User UI is comprised of the following modules that help you organize your structural hierarchy, provision and access edge devices, deploy applications, and more. | **Module** | **Description** | | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Company List](docId\:wHnlfM1BSMMeVqSjwgjCW) | Enables you to add or select a company | | [Project List](docId\:s4NipWXcYdUU6O0DowYQQ) | Enables you to add or select a project under a company to visualize and organize where an edge device fits into the overall architecture | | [LEM Dashboard](docId\:NICP2iziO86MTz4iqR5DP) | Shows statistics about the selected project | | [Licenses](docId\:D6OmBvcrDDBIvgqMZPx9h) | Shows the license status for your edge devices | | [Sites](docId\:p7mV_xMRxKKbHgjO53FuQ) | Enables you to add or select a site to visualize and organize locations in the overall architecture | | [Edge Devices](docId\:pqRVYqspADLvoCpHmC3WA) | Enables you to access edge devices, devices connected to them, and view their activation status | | [Activation](docId:0vtl5o6-X3oMmsEDaTaoP) | Allows you to provision a connection between an edge device and Litmus Edge Manager | | [Templates](docId\:Me1x3I4rPT_IIgNPCY1GA) | Enables you to create a template from an edge device or upload one from a file | | [Applications](docId\:bdLsrr7TeEHzdsDFQOyYm) | Enables you to access applications from a marketplace catalog and deploy them to selected edge devices | | [Certificates](docId\:T69a0U8TveV6_zLSe5QwV) | Allows you to manage SSL certificates on edge devices and provides a comprehensive summary of all your certificates, sorting and filtering options, and the ability to upload or issue a certificate. | | [AI/ML Models](docId:7swv21tXSDTVE8ubZB1oj) | Allows you to manage and bulk deploy machine learning models on edge devices.
It also provides a comprehensive summary of all your models, sorting and filtering of the models list, and the ability to upload new machine learning models. | | [Remote Access](docId:8E9YOSIkqCSaffDQFp7AX) | Shows a list of network nodes available for the selected project in the ZeroTier Network pane
Shows a list of connected edge devices in the Edge Remote Network pane | | [Software Update](docId:2vCj2fF1K9z-dd9sCfn0O) | Enables you to add software jobs for edge devices | | [Events](docId\:OnS8mKWpVtKc93cOoRAKm) | Allows you to view events from the System Events pane
Allows you to view events for edge devices from the Edge Devices Events pane | | [Alerts](docId\:BWq6oBkuTNZgIJBIgQPBE) | Enables you to add incidents, actions and triggers to send notifications based on events | | [Marketplace](docId\:gqoGt_Szm8rz9UdPhl2NL) & [Grafana](docId\:YTC1N5pOOjR1elW34jQmF) | Enables you to access marketplace catalogs and applications they contain, as well as registries and Grafana dashboards | | [Settings](docId\:TtMXMjSU3mXYcNVreT9Fn) | Provides you with information about company and project status and their various resources | | [Digital Twins](docId\:Hvp_-8GHJdHgc7_sTBj-s) | Provide a system that is used for real-time monitoring, analysis, and optimizations | [title] Configuration [path] Litmus Edge Manager User UI/Product Features/Activation/ The Configuration sub-module allows you to begin provisioning an edge device. The Activation Configuration pane allows you to view the following information: - **Activation code**: Click the activation code link to view or edit details about the configuration. - **Expires**: View the expiration date for the selected activation code. - **License type**: View the type of license for the selected activation code. - **Licenses**: View the number of licenses added for the selected activation code if this is a node-locked license. - **Templates**: View the number of templates added for the selected activation code. - **Usage**: View the number of edge devices using the selected activation code. - **Created On**: View the date the activation code was created. - **Action**: Select options to edit, show usage or remove the selected activation code. When you add or select an Activation code link, the Activation Config List appears. The Activation Config List includes the following sections: - Activation Code - Limits - License Type - Licenses - Templates - Template Variables # Access Activation > Configuration UI **To access the Activation Configuration UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The *Dashboard* pane appears for the project. - Click the **Actions** icon for a project, and then select **View**. The *Dashboard* pane appears for the project. 4. From the *Navigation *panel, select **Activation**. The *Configuration* and *Requests* sub-modules drop down. 5. From the navigation panel, select **Configuration**. The *Activation Configuration* pane appears. Refer to the following actions you can take on the *Activation* *Configuration* tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Xi8bmLZ-sz0bNrIO3DzmV_sknwv6ocbnyhlkrypfptg2023-07-2011-13-31.png "Activation Configuration") | **Action** | **Details** | | ------------------------------- | ----------------------------------------------------------------------------- | | \[1] **Make device backup** | Initiates a backup process for the edge device's current configuration. | | \[2] **Upload new backup file** | Allows you to upload a new backup file to replace the existing configuration. | | \[3] **Reload Features** | [Set Up an Activation Config](docId\:VbRFW-a0LLtuJmwdpuNNV) | | \[4] **Action menu** | - Edit - Show Usage - Remove | [title] Events [path] Litmus Edge Manager User UI/Product Features/ You can view the Events pane from a company or from an open project. # Company Events Pane The Company Events pane allows you to select a start and end date for the events you want to view. You can select an event type to filter the event list. Options are: Team/Member, Project, Device, Revoke, and All Events. You can add criteria in the Filter field to further narrow the events list. :::hint{type="info"} **Note: **The *deactivation *event type is available for Litmus Edge Manager version 2.18.0 and later. ::: ## Access Company Events Pane **To access the events UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. From the Navigation panel, select Events. The *Events* pane appears. Refer to the following actions you can take on the *Events* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/QIjgItnjO9QtJrEC3_XC9_jc0edhddmajkyoeqppwxeimage.png "Events \[Company View]") | **Action** | **Details** | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Select Start Date** | Choose the starting date. | | \[2] **Select End date** | Choose the ending date. | | \[3] **Select Event type** | Select from various event types related to:
* Activation and Deactivation (Deactivation is Available for Manufacturing Connect version 2.18.0 and later) * Analytics * Authentication * Cloud Storage * Company and project * DataHub * Digital Twins * Device and device management * DeviceHub * Flows * Git synchronization * Grafana * Licensing * Integrations * Marketplace * Revoke * System * Team and team member | | \[4] **Filter** | Search by *User* or *Event* . | | \[5] **Refresh** | Update the list. | # Project Events Pane The Project Events pane includes: - **System Events**: The System Events pane allows you to select a start and end date for the events you want to view. You can select an event type to filter the event list. You can also add criteria in the Filter field to further narrow the events list. The System Events list includes a timestamp, type, user, and event message for each event. - **Edge Devices Events**: Edge Events allows you to view events for the entire date range over its life cycle. You must enable event forwarding for the edge device. :::hint{type="info"} **Notes**:  - Edge event management is an experimental feature which must be enabled from Litmus Edge Manager Admin Console. See [Experimental Features](docId\:PtIJysv_x6gV1g0Z4oR2B) for more information. - The trigger for *Events* in Edge devices will only work if the *Forward Events *toggle is enabled. If this option is not activated, you won’t be able to see any logged events. You'll only have access to the event logs after turning on this feature; otherwise, previous logs will remain inaccessible. ::: The Edge Devices Events pane allows you to select and apply a start and end date for the events you want to view. You can select options from the Severity, Component, Edge Device ID filters to further narrow the entries. You can filter a specific event by device or by component. You can click the device **ID** link, which navigates you to the selected *Edge Device Details* pane in the *Events *tab. From the Events tab in the Edge Device Details pane, you must enable **Forward Events**. This allows you to receive alerts when you use actions and triggers in the Alerts module. :::hint{type="info"} **Note**: Litmus Edge Events can be a source for Litmus Edge Manager Alerts. You can define triggers based on the Litmus Edge Events and get notifications. ::: ## Access Project Events Pane **To access the Project Events pane: ** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The *Dashboard *pane appears for the project. - Click the **Actions** icon for a project, and then select **View**. The *Dashboard *pane appears for the project. 4. From the Navigation panel, select **Events**. The *Events* pane appears. By default, *System Events* tab appears. Refer to the following actions you can take on the *System Events* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/QXbA10YF79GwKbbCCoSAg_o9ovyamkawzh8tdkjojblimage.png "Events \[Project View]: System Events tab") | **Action** | **Details** | | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Select Start Date** | Choose the starting date. | | \[2] **Select End date** | Choose the ending date. | | \[3] **Select Event type** | - Company - Project - Device - Activation - Deactivation (Available for Litmus Edge Manager version 2.18.0 and later) - Team - Team/Member - Revoke - Grafana - All Events | | \[4] **Filter** | Search by *User* or *Event* . | | \[5] **Hide filter** / **Show filter** | Display the conditional list. | | \[6] **Swap between System Events and Edge Devices Events** | Choose between two types of events. | Refer to the following actions you can take on the *Edge Device's Events* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/mo_ex7YUqzXkjIKCl81Br_image.png "Events \[Project View]: Edge Device's Events tab") | **Action** | **Details** | | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | \[1] **Select Start Date** | Choose the starting date. | | \[2] **Select End date** | Choose the ending date. | | \[3] **Select Event type** | - Company - Project - Device - Activation - Deactivation (Available for Litmus Edge Manager version 2.18.0 and later) - Team - Team/Member - Revoke - Grafana - All Events | | \[4] **Filter** | Search by *User* or *Event* . | | \[5] **Hide filter** / **Show filter** | Display the filter. | | \[6] **Swap between System Events and Edge Devices Events** | Choose between two types of events. | | \[7] **View Edge Device ID** | ****[Events](docId\:Qh9PnCUT-G1k_Lz9p4-m3) | | \[8] **View Severity Info** | Display severity information. | | \[9] **View Event Info** | Display events information. | | \[10] **Action Menu** | * **Filter by Device: **You can further narrow the list by selecting a start and end date. * **Filter by Component: **You can further narrow the list by selecting a start and end date. | | \[11] **Show filter** / **Hide filter** | Expands / Hides features \[12]-\[16] | | \[12] **Select Severity** | - All - Info - Warning - Alert - Error | | \[13] **Select Component** | * All * auth - Auth * cc - Integrations * dh - Device Hub * dm - Device Management * mp - Marketplace | | \[14] **Select Edge Device ID** | Displays all available connected devices | | \[15] **Select Start Date** | Choose the starting date. | | \[16] **Select End Date** | Choose the ending date. | **** **** **** [title] Upload License CSV [path] Litmus Edge Manager User UI/Product Features/Licenses/ :::hint{type="info"} **Note**: This feature is available for Litmus Edge Manager version 2.18.0 and later. ::: You can add multiple licenses with a single CSV file. :::hint{type="info"} **Note:** Ensure that the CSV file contains the required column names in the correct order as follows: `license key`, `license SKU`, `isCore` ::: # Before You Begin Ensure you have a CSV file with the required License keys. **To upload license keys from a CSV file:** 1. From the *Licenses Summary *pane, click **Upload License CSV**. The *Upload license keys* dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/kiS6JbvLVW3bA_FR7XHGH_image.png" size="100" isUploading="false" width="1733" height="534" showCaption="false" indent="2"} 2. Click the **SELECT FILE** button and navigate to select the file from your local computer. - **File Name: **(Optional) Rename the file if needed. - Example of the *CSV file* is available [here](https://dev.em.la2.space/scripts/components/license/license-upload-example.csv). 3. Click **UPLOAD**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/W7Ly27N07R8vQv6uS5ObW_image.png" size="30" width="293" height="322" position="center" caption="Upload license keys dialog box" showCaption="true" indent="2"} [title] Set Up an Activation Configuration [path] Litmus Edge Manager User UI/Product Features/Activation/Configuration/ An activation configuration can be configured with limits, license keys, template and/or template variables. These configurations are all entirely optional. Some of these configurations have existing default values while others can be left blank. These configurations are all implemented in the first four steps and can be skipped if no additional customization is needed. Generating the details for an activation configuration occurs only in *Step 6: Save* while retrieving the key details are in *Step 7: Retrieve Activation Code/URL*. # Before You Begin - If you are using a node-locked license, make sure you have a license key for deployment. To get a license key, contact your Litmus account executive. - If you are using a site-based license, make sure you have the URL and port for the license server. See [License Server Management](docId:5U_hNNsaVs--E5HQJEQ0O). # Step 1: Configure Limits After navigating to **Activation **> **Configuration **and clicking the **Add activation config** icon, you can start configuring the limits. You have the option of configuring limits, specifically number of edge devices, lease TTL and expiration date. If no changes are needed, proceed to the next step. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/4SN1XZ4nJ2jciUlGzPYQ1_image.png" size="80" width="1916" height="335" position="center" caption="Config Limits" showCaption="true"} - **Number of Edge devices:** Enter the number of devices that will share the activation code. The activation code (created after saving) can be used for multiple edge device activation. - **Lease TTL for identity certificate:** Enter the number of days the identity certificate for the activation will be valid from the day you activate the edge device. - **Expiration Date**: Select the expiration date when the activation code can no longer be used. # Step 2: Configure Licenses and License Types You have the option of using either a node-locked or a site license. By default, a node-locked license is selected. - A node-locked license associates and attaches a license with a Litmus Edge instance. Use this option for assigning one license to each edge device. - A site license is when Litmus Edge obtains a license from a Litmus Edge License Server. Use this option to specify the IP address of the license server. See [Site and Node-Locked License Overview for Litmus Edge](docId\:nbX0O6C5ylSh-qVy0sdJc) to learn more. If no changes are needed, proceed to the next sub-step. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/KM04NTBSz0MY4wfoolG0K_image.png" size="80" width="1711" height="126" position="center" caption="Configure License and License Type" showCaption="true"} ## Configure a Site-based License Ensure the site-based license has already been applied in Litmus Edge Manager before activating the device. The site license must be created through *Offline activation* in [License Server Management](docId:5U_hNNsaVs--E5HQJEQ0O). ## Configure a Node-locked License You have the option of adding node-locked license SKUs manually or uploading them in a file. ### Add License SKU Manually ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/4QQIlZA580qixxWNIq5mj_image.png" size="80" width="1675" height="382" position="center" caption="Adding node-locked keys manually" showCaption="true"} **To manually add a node-locked license key**: 1. Select the checkbox for **License SKU**. Only one core license SKU can be selected. ### Upload License Keys ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/FFyjHlpWyKV8IEDDTRGs7_image.png" size="80" width="1667" height="384" position="center" caption="Uploading node-locked keys" showCaption="true"} **To upload node-locked license CSV**: 1. Click the **Upload** icon. The *Upload license keys *dialog box appears. 2. Click the **SELECT FILE** button and navigate to select the file from your local computer. - **File Name: **(Optional) Rename the file if needed. - Example of the *CSV file* is available [here](https://dev.em.la2.space/scripts/components/license/license-upload-example.csv). 3. Click **UPLOAD**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/W7Ly27N07R8vQv6uS5ObW_image.png" size="30" width="293" height="322" position="center" caption="Upload license keys dialog box" showCaption="true"} # Step 3: Add Templates You have the option of applying templates when activating a Litmus Edge instance. Learn more about [Templates](docId\:Me1x3I4rPT_IIgNPCY1GA). If the Litmus Edge instance doesn't need a template, proceed to the next step. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/x2P_b1G24sZ07GZkOT9ht_image.png" size="80" width="1912" height="158" position="center" caption="Add Templates" showCaption="true"} **To add at least one template**: 1. From the *Template *section, click the **Add** icon. The *Template Select *dialog box appears. 2. Select one or more templates from the list, and then click **Select**. The selected template appears in the *Templates* list. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/H3R0dkvHOzin-UiqrOz_D_image.png" size="80" width="1525" height="462" caption="Litmus Edge Manager User UI : Activation > Configuration : Activation Config 3/7 Template Select" position="center" showCaption="true"} # Step 4: Add Template Variables You have the option of applying template variables when activating a Litmus Edge instance. Before using template variables, you need to [Parameterize a Template](docId\:ol2rl-sxp_6Y4ISmGzhXA). If the Litmus Edge instance doesn't need any template variables, proceed to the next step. ## Adding Template Variables Manually ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/szmwiO8X6j_Ff-FiaGsJV_image.png" size="80" width="1911" height="162" position="center" caption="Add Template Variables" showCaption="true"} **To add at least one template variable manually:** - From the *Template Variables*** **section, click the **Add **icon. The *Add new variable set* dialog box appears. ### Adding Template Variables for All Devices ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/VjiaO_6PuhnVHdl7zZTU7_image.png" size="60" width="574" height="338" position="center" caption="Add new variable set dialog box" showCaption="true"} **In order to add template variables for all devices:** 1. From the *Add new variable set*** **dialog box, click the **Variable set type toggle** so it displays *All Devices*. 2. Click **Add**. The Variable set: *All devices *appears in the* Template Variables* list. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/j2iDs6WteGq_3HZCm3cPL_5zrudc58c-uy1k-4hw-rzimage.png "Add new variables for All Devices") 3. Click the **Add** icon next to the variable set. The Variables line items drop down. 4. In the **Variable Name **field, enter a variable name. 5. In the **Variable Value **field, enter a variable value. ### Adding Template Variables for Individual Edge Device ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/_P1qfcHi3mCThhyYYxppJ_image.png" size="60" width="579" height="342" position="center" caption="Add new variable set dialog box" showCaption="true"} 1. From the *Add new variable set*** **dialog box, click the **Variable set type** toggle so it displays *Per Edge Device*. 2. In the **Host Name** field, enter the host name for an edge device. To find host name for an edge device, see [Configure the Network Settings](docId\:jW2n7vOhntfAgknzoyLQc)' *Host Information*. 3. Click **Add**. The Variable set: *per Edge Device*: \ appears in the *Template Variables* list. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/p-HZNKyCC8P0pKcMVOG_G_e0wobrnpssfg5w0ajzflimage.png "Add new variables for per Edge Device") 4. Click the **Add** icon next to the variable set. The *Variables *line items drop down. 5. In the **Variable Name **field, enter a variable name. 6. In the **Variable Value **field, enter a variable value. ## Adding Template Variables Using .csv File Multiple template variables can be uploaded using a `.csv` file. A sample `.csv` file is available to download for customization. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/a43ztvQoMFpG2juZOYL2Z_image.png" size="80" width="1919" height="154" position="center" caption="Upload Template Variables" showCaption="true"} **To add at least one template variable using a .csv file :** 1. From the *Template Variables* section, click the **Upload **icon. The *Upload variable sets* dialog box appears. 2. (Optional) Click the here link to download a sample `.csv` file. 3. Click** Select File**, navigate to a variable set `.csv` file, and then click **Open**. The selected `.csv` file appears in the *File Name* field.** ** 4. Click **Upload**. The variable sets listed in the `.csv` file appear in the *Variable Sets* list. # Step 5: Provision Options :::hint{type="info"} **Note**: The* Provision Options* feature is available for Litmus Edge Manager 2.12.0 and later. ::: To apply the [AWS Sitewise Edge integration](https://app.archbee.com/docs/SuELLqhxHnnKWA4eA6SOc/kVu1bRiEO0GO-psXWR-aw) during activation, select the *AWS SiteWise Edge Integration *checkbox. This feature enables Litmus Edge to connect with the AWS Sitewise Edge MQTT broker when deploying LE components using the AWS Sitewise console. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/cRpst8qB7ANzfTLd-Gz6Y_image.png) To apply the [default password policy](docId\:nZxdm63Ip1guJ_mQiN140) during activation, select the *Password Policy* checkbox. If there are multiple password policies, the master default password policy that can't be deleted is implemented. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3D3wsm5y7PhRA1XK-lfR6_image.png" size="80" width="1071" height="102" position="center" caption="Provision Options section" showCaption="true"} After activation, you can update the [default password policy](docId\:CMHGjEOLZn_qu_jlOjdBO) for individual edge devices. # Step 6: Configure Advanced Settings :::hint{type="info"} **Note**: The* Advanced Settings* feature is available for Litmus Edge Manager 2.11.0 and later. ::: When Litmus Edge Manger (LEM) connects to a Litmus Edge (LE), it uses Remote Access. Remote Access has a parameter `PersistentKeepalive` that you can reconfigure on how often to send an authenticated empty packet to a Litmus Edge for the purpose of maintaining the LEM-LE connection. By default, Remote Access uses 22 seconds. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1yANrjF0Uh79RC7jZ1AuZ_image.png" size="80" width="1905" height="189" position="center" caption="Remote Network Persistent Keepalive Interval" showCaption="true"} To set advanced settings, from the **Remote Network Persistent Keepalive** field, enter a number of seconds between 1-25. # Step 7: Save When done configuring the Activation Configuration, click** Save**. Once saved, the activation code will then be generated at the *Activation Code* field. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/J8oHULh4be53wsFOlialR_image.png" size="80" width="1920" height="969" position="center" caption="Save Activation Config" showCaption="true"} # Step 8: Retrieve Activation Code/URL After saving, the activation code will display underneath the *Activation Code* section. This code and the *Activation URL* will be needed when activating a Litmus Edge instance. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/YQY0EFKlqVaY8QDNkLCQr_image.png" size="80" width="1920" height="969" position="center" caption="Retrieve activation code/URL" showCaption="true"} **To retrieve the activation code/URL**: 1. **Copy to clipboard** the *Activation Code*. It will be needed for activating a Litmus Edge instance. 2. **Copy to clipboard** the *Activation URL*. It will be needed for configuring a Litmus Edge instance. # Next Steps Use the copied *Activation Code *and *Activation URL* to [Activate an Edge Device](docId\:G1kWiYDlSR5u8qEJk0djp). [title] AI/ML Models [path] Litmus Edge Manager User UI/Product Features/ :::hint{type="info"} **Note**: The AI/ML Models feature is available for Litmus Edge Manager 2.21.0 and later. ::: The AI/ML Models module in Litmus Edge Manager (LEM) allows you to manage and bulk deploy machine learning models on edge devices. It also provides a comprehensive summary of all your models, sorting and filtering of the models list, and the ability to upload new machine learning models. You can only upload the models as a **ZIP** file containing a saved model directory with variables, assets, and a .pb (protocol buffer) file. # Access AI/ML Models UI **To access the AI/ML Models UI: ** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects *pane appears. 3. Do one of the following: - Click a project from the *Project* pane. The *Dashboard* pane appears for the project. - Click the **Actions** icon for a project, and then select **View. ** The *Dashboard* pane appears for the project. 4. From the Navigation panel, select **AI/ML Models. ** The *AI/ML Models Management* pane appears. Refer to the following actions you can take on Litmus Edge Manager's *AI/ML Models *pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/qJtJ1w4N7TmaMPB5uVjTO_image.png) | **Action** | **Details** | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | \[1] **View **[Edge Devices](docId\:V2neW0C22znuUlXwQd2Wm)** details** | Display the details of edge devices. | | \[2] **BULK DEPLOY** | Upload multiple models at once. See [Deploy AI/ML Model](docId\:YPC12P4q3kfMW5XNNAtDp) for details. | | \[3] **AI/ML MODELS** | Upload a new model or display available models.
* [Import AI/ML Models](docId\:NejWAOLMno3aSEMjsafyR) | | \[4] **Action** | - [Deploy AI/ML Model](docId\:YPC12P4q3kfMW5XNNAtDp): Access machine learning models on your edge devices - Delete a Model | :::hint{type="info"} **Note: **You can use AI/ML Models by using the [TensorFlow Images Processor](docId\:Tif714q103-7CRa2RY44P) & [TensorFlow Processor](docId\:QKgSmS2EOcVzHa2lYAUkl) Analytics functions. ::: [title] Metrics [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ Once an edge device begins communicating with Litmus Edge Manager, the metrics of your edge device become available in the *Metrics* tab. The tab is divided into two sections: - **DeviceHub** - lists all devices connected to the edge device; shows their status and the number of tags - **Integration** - lists integration connectors defined for the edge device; shows their status, rate, and buffer size Refer to the following metrics you can refer to on the Litmus Edge Manager User UI's *Edge Devices Metrics* tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/OX0n4ysSynbWeX_uxLrsn_image.png "Edge Devices Metrics") | Section | Column | Description | | --------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Device Hub** | **Name** | The name of the device connected to the edge system. | | | **Tags** | The number of tags associated with the device. | | | **Success \| Error Rate (msgs/min)** | The rate of successful and error messages per minute for each device. | | | **Status** | The current status of the device connection.
* A green dot indicates a device is online. * A red dot indicates a device is offline. | | \[2] **Integration ** | **Name** | The name of the integration service used by the edge system. | | | **Rate (msgs/min) ** | The rate of messages per minute processed by the integration. | | | **Buffer Size ** | The current buffer size of the integration. | | | **Status ** | The current status of the integration.
* A green dot indicates online status. * A red dot indicates offline status. | ## Additional Metrics You can use additional metrics sources to set up an alert based on metrics collected by Litmus Edge Manager. The alert can trigger when a variable reaches a specific value or a set/interval of values. Only one metrics rule can be created per alert. See [Set Up Alert Triggers](docId\:ssMqiDTPoBpV95sc3lkaC) for more. :::hint{type="info"} **Note:** You can set up alert triggers for different metrics of your edge devices in the *Triggers* section in the *Alerts* module. Review the [Alerts Guides](docId\:Z6I7f1kbZSHNsn6FZliSe) for setting up alert triggers. ::: Refer to the following table for more information on additional metrics available for alerts template: | **Source** | **Metrics Name** | **Description / Purpose** | **Parameters** | | ----------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | | Integration | Connector disk buffer | Monitor [Integration](docId\:Wpqo1fE02tmx3AsKewQU6) Connector disk buffer, which is used when the connector’s throughput is insufficient to handle all defined tags coming from Edge devices. | - Target Value in MB - Alert Delay in seconds | | Integration | Connector online status | Detect unplanned [Integration](docId\:Wpqo1fE02tmx3AsKewQU6) Connector disconnections. | * Alert Delay in seconds | | DeviceHub | DeviceHub (DH) online status | Detect unplanned disconnections of DeviceHub (DH) devices. | - Alert Delay in seconds | | DeviceHub | DeviceHub (DH) device data quality | Monitor the rate of low-quality (i.e. error) messages. A high rate of low-quality messages indicate a problem with either the physical device or the device driver. | * Target Value in msgs/minute * Alert Delay in seconds | | Edge Device | Edge Device online status | Detect unexpected disconnections of edge Devices. | - Alert Delay in seconds | | Edge Device | Edge Device license expiration | Detect when the license of an edge device has expired. | * Target Value in days * Alert Delay in seconds | | Edge Device | Edge Device free disk space | Monitor the available disk space of an edge device. | - Target Value in Percentage - Alert Delay in seconds | | Edge Device | Edge Device memory available | Monitor the available memory of an edge device | * Target Value in Percentage * Alert Delay in seconds | | Edge Device | Edge Device CPU Idle | Monitor the CPU usage of an edge device | - Target Value in Percentage - Alert Delay in seconds | [title] Software Update [path] Litmus Edge Manager User UI/Product Features/ After selecting a project, the Software Update module appears. The Software Update module includes a list of runnable tasks for edge devices. This module also contains a **Current (#)** tab to view `PENDING` or `RUNNING` tasks and a **History (#)** tab to view `COMPLETED` or `ERROR` (failed) tasks. You can add a software task, run a task, cancel a task, or view info about current and previous tasks. :::hint{type="info"} **Note**: Software packages are added from the** ***Images *module in the Litmus Edge Manager Admin Console. See [Edge Software Update](docId:3IevluZfOdrXAqOOpVT1n). ::: Single or multiple tasks can be scheduled for edge devices. You can use user-defined commands that can be scheduled to be executed. You can restart and update Litmus Edge software. # Access Software Update UI **To access the Software Update UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The *Dashboard *pane appears for the project. - Click the **Actions** icon for a project, and then select **View**. The *Dashboard *pane appears for the project. 4. From the Navigation panel, select **Software Update**. The *Software Update* pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/AbDXJqNk6kbdju4iSE3Fx_image.png) # Next Steps - [Add New Software Update Tasks](docId\:i24b2ShVA4EeOxUPftj_M) - [Cancel Software Update Tasks](docId\:iL8M8kElSD-uOcYbUZSc9) [title] Sites [path] Litmus Edge Manager User UI/Product Features/ *Sites *allows you to divide your project into smaller areas of interest. After selecting a project, the *Sites *module appears. You can add, remove, and visualize edge devices deployed to a categorized site. You can also add mapping to edge devices based on the edge device location. Clicking an edge device's ID in the Site Points pane automatically navigates you to the edge device details Info tab where you can perform device management. This makes it more convenient for plant managers to monitor devices deployed in their plant, based on site location. # Access Sites UI **To access the Sites UI: ** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Do one of the following: - Click a project from the *Project *pane. The *Dashboard *pane appears for the project. - Click the **Actions** icon for a project, and then select **View**. The *Dashboard *pane appears for the project. 4. From the Navigation panel, select **Sites**. The* Sites* pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/PjGzDCH-jz7zXookDmSXT_2023-07-1710-14-44.png "Sites") # Next Steps The following operations are available for **Sites**: - [Add a New Site](docId\:oV_8SWPS-P-gJmuQiPQQu) - [Manage Sites](docId\:ZKCauvtH-lr1nWNOWXSUM) [title] Manage Applications [path] Litmus Edge Manager User UI/Product Features/Applications/ From the *Applications *pane, you can select a catalog to view, deploy (launch) an application for your connected edge devices, and view an application's details where you can view the edge devices for which the application has been deployed. Refer to the following actions you can take on the *Applications* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/nSLagWN0k0zOTcBP8rfbg_image.png "Managing Applications") | **Action** | **Details** | | ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Show filter** / **Clear and close Filter** | Search by *Name* or *Description *after entering at least 3 characters. | | \[2] **Push Marketplace catalogs to Edge devices** | Distribute Marketplace catalogs to connected Edge devices. | | \[3] **Select Catalog** | - **Filter** - **Show all** | | \[4] **View **[Application Details](docId\:y0_poW_FPmobqHrwyI5Wk) | Examine detailed information about the selected application. | | \[5] **Action menu ** | * **Launch App: **[Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw) * **Details: ** [Application Details](docId\:y0_poW_FPmobqHrwyI5Wk) | [title] Company List [path] Litmus Edge Manager User UI/Product Features/ Litmus Edge Manager includes a way for you to create a hierarchy to structure how different edge devices fit into the IT/OT environment of a company or enterprise. This hierarchy follows the same principles as other devices such as servers, PC systems, or PLCs/controllers. You can then visualize and organize where an edge device fits into the overall architecture. The first level of the hierarchy is called **Companies**. Companies are the highest hierarchy level under which everything is structured. Options can be the enterprise, company, or division/subsidiary names. Other valid choices are the name of a country, region, state, or city, as well as production site. These names are based on how you understand your own hierarchy and how the hierarchy will represent the architecture. When you are working in a module for a company, Litmus Edge Manager remembers after you log out so the last module in the company you worked on appears when you log in. See [Company Settings](docId\:XwUuYveHjgIbb0bYwlwSt) for more information about how to manage companies. Refer to the following actions you can take on the Litmus Edge Manager User UI's *Companies *pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/dJ1sjrWhU82UUbOqN8G6D_image.png "Company List View") | **Action** | **Details** | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] [Add a Company](docId\:QS1mbPG-tWRCyAAWe5Iya) | Allows users to create and organize new company entries within the Litmus Edge Manager. | | \[2] **Company tile** |
* **Projects: **Total number of projects. * **Edge Devices:** - For Litmus Edge Manager version 2.16.5 and earlier, the number of total activated edge devices displays. - For Litmus Edge Manager 2.18.0 and later, the number of online edge devices out of the total number of activated edge devices displays. * **Digital Twins Models: **Total number of digital twin models. * **Edge Lifecycle Management: **Where users can manage Litmus Edge devices. * **Asset Management: **Where users can access the Digital Twins module. | # Next Steps - [Add a Company](docId\:QS1mbPG-tWRCyAAWe5Iya) - [Select a Company](docId\:QG9YTJQ6XZ5e0aHlmG6nJ) - [Manage Multiple Teams and Members](docId\:wuZwvesh2sg-Er9FjK6OP) [title] Backup [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ Upon activation of an edge device, the backup files for the edge device are automatically stored in the **Backup** tab. You can make an edge device backup, upload an edge device backup, and restore from a backup file for the edge device. You can perform actions from a listed backup file. Options are: download, start restore, and remove a backup file. You have the option of configuring the backup retention policy in the *Settings *section of Litmus Edge Manager. See [Project Settings](docId\:hmGSXiivMvDy4K43OanRv) to learn more. Refer to the following actions you can take on the Litmus Edge Manager User UI's *Edge Devices Details Backup* tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/rExsauvBkkhItaoopAWjt_2023-07-2011-12-18.png "Backup tab") | **Action** | **Details** | | ------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | \[1] **Make device backup** | Create a new backup file for the edge device. | | \[2] **Upload new backup file** | Select `MASTER` or `FLOWS` | | \[3] **Reload Features** | Delete multiple backups concurrently. This feature is available for Litmus Edge Manager version 2.8.0 and later. | | \[4] **Refresh** | Update the backup tab to display the latest information. | | \[5] **Action menu** | - Download - Start Restore - Remove | [title] Manage Sites [path] Litmus Edge Manager User UI/Product Features/Sites/ After you create a site, the *Sites* pane offers a list of actions to manage them. Refer to the following actions you can take on the Litmus Edge Manager User UI's *Sites* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/jJXgIlOXAkVzRJOJ1F8uX_2023-07-1710-18-46.png) | **Action** | **Details** | | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **View**/**Edit site** | See [Add a New Site](docId\:oV_8SWPS-P-gJmuQiPQQu) for details | | \[2] **Show Site Points** | See [Show Site Points](docId\:Mzmtln8Y5iBNYL9GZBmqe) details | | \[3] **Delete** | Remove any site from the list. | | \[4] **Action menu** | - **View/Edit: **See [Add a New Site](docId\:oV_8SWPS-P-gJmuQiPQQu) for details - **Show Site Points: **See [Show Site Points](docId\:Mzmtln8Y5iBNYL9GZBmqe) for details - **Delete** | | \[5]** Show filter** / **Hide filter** | Search by *Name* or *Description* | | \[6] **Change to Table**/**Module view** | Modify the table to module view. | [title] Manage a Site and Site Points [path] Litmus Edge Manager User UI/Product Features/Sites/Show Site Points/ You can hover over a map site point to view the name, status and type of the edge device. Refer to the following actions you can take on the *Show Site Points* pane. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/dtJBTbZYMInsLVMwVLCQ7_image.png" size="80" width="1920" height="969" darkWidth="1920" darkHeight="969" position="flex-start" caption="Site Management" showCaption="true"} | **Action** | **Details** | | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] [Edge Device Details](docId\:YwQwD4skuVTwNtcAV5ijs) | View details of connected edge devices. | | \[2] **View Data \| Control Status** | Check the status of the data flow. | | \[3] **Show filter / Hide filter** | Search by *Name.* | | \[4] **Save** | - **View/Edit: **See [Add a New Site](docId\:oV_8SWPS-P-gJmuQiPQQu) for details - **Show Site Points: **See [Show Site Points](docId\:Mzmtln8Y5iBNYL9GZBmqe) for details - **Delete** | | \[5]** Action menu** | * **Remove: **The selected edge device must be online. | | \[6] **Site Point ** | Hover over the mapping point to more information. Click and drag to change the site point location on the site map. | [title] Personal Settings and Support Chat [path] QuickStart Guide/ :::hint{type="info"} **Note**: The Personal Settings feature is available for Litmus Edge Manager 2.7.0 and later. ::: This feature offers enables you to toggle a chatbot (that is displayed across all LEM interfaces) that assists you in contacting a Litmus representative directly. # Access Personal Settings UI *Personal Settings* are available both on Litmus Edge Manager User Interface and Litmus Edge Admin Console. **To access the Personal Settings UI:** 1. Log in to Litmus Edge Manager or Litmus Edge Manager Admin Console. 2. From the top of the window, click the **User** icon, and then select **Personal Settings**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/J4t5KSRFmELvrl4J3rNBd_image.png" size="80" width="1920" height="914" caption="Litmus Edge Manager User Interface : Access Personal Settings 1/2" position="center" showCaption="true"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/dXvtKFUzP3Y4dCQynx8Ay_image.png" size="80" width="1920" height="914" caption="Litmus Edge Manager User Interface : Access Personal Settings 2/2" position="center" showCaption="true"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/nYshqwqeq-4vUDk0MOxBb_image.png" size="80" width="1920" height="914" caption="Litmus Edge Manager Admin Console : Access Personal Settings" position="center" showCaption="true"} Refer to the following actions you can take from the *Personal Settings* pane. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/K3Se1nxVRiKxnZFQOAQiw_image.png" size="80" width="1741" height="901" caption="Litmus Edge Manager User Interface / Admin Console: Personal Settings" position="center" showCaption="true"} | **Action** | **Details** | | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Enable/Disable Connected Features** | Toggles the availability of the support chat box. | | \[2] **Expand/Collapse Support Chat Box** | This support chat box is available on every other page of Litmus Edge Manager User Interface and Litmus Edge Manager Admin Console. | [title] Details [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ The *Details* tab includes device status, disk, memory, CPU, network interfaces, serial interfaces, modem interfaces, and CAN interface information for a selected edge device. :::hint{type="success"} **Tip**: If data does not display: - Check the device status from the Edge Devices pane to see if data is connected. See [Step 7: Verify Edge Device Activation in Litmus Edge Manager](docId\:KC9sqRSng2KSINWL1PfPi). - Check the edge device information in Litmus Edge. See [Info](docId\:YIwyPagdCmgYF_px_-wgA). ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/cfhSRjNK3IPF_WnIfs__C_image.png" size="90" width="1920" height="969" position="center" caption="Details tab 1/2" showCaption="true"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/veMzSCQMdbfzmeqJGPq7P_4o2xvaxb-zw1rjnsbteggimage.png" size="80" width="1739" height="837" position="center" caption="Details tab 2/2" showCaption="true"} # Edge Device Information The following sections include information about the edge device. :::hint{type="info"} **Note**: The sections that display for an edge device may differ according to the type of device. ::: ## General | **Label** | **Description** | | ---------------- | ------------------------------------------------------ | | Model Number | The model number for the edge device. | | Manufacturer | The manufacturer of the edge device. | | Firmware Version | The current firmware version used for the edge device. | | Hardware Version | The hardware version used for the edge device. | | Serial # | The serial number for the edge device. | ## Status | **Label** | **Description** | | ------------------------- | ---------------------------------------------------------- | | Status / Activation | If the edge device online status is active or deactivated. | | Control Client Address | The URL for the client. | | Control Registration Date | The date and time the edge device was registered. | | Control Last Update | The last date and time the edge device was updated. | | Control Type | The type of component that controls the edge device. | ## Disk | **Label** | **Description** | | ----------------- | -------------------------------------------------------- | | Used Storage | The percentage of used storage for the edge device. | | Available Storage | The percentage of available storage for the edge device. | | Total Storage | The total storage for the edge device in KB. | | Storage Used | The storage used for the edge device in KB. | | Storage Available | The available storage for the edge device in KB. | ## Memory | **Label** | **Description** | | ---------------- | ------------------------------------------------------- | | Used Memory | The percentage of used memory for the edge device. | | Available Memory | The percentage of available memory for the edge device. | | Total Memory | The total memory for the edge device in KB. | | Used Memory | The used memory for the edge device in KB. | | Available Memory | The available memory for the edge device in KB. | ## CPU | **Label** | **Description** | | ----------- | --------------------------------------------- | | Model | The model of CPU(s) used for the edge device. | | Cores # | The number of cores for the CPU model. | | Clock Speed | The clock speed of the CPU model. | | Vendor ID | The vendor for the CPU model. | ## Network Interfaces | **Label** | **Description** | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Interface | Type of network interface. It can be an ethernet (eth0 or eth1), a Wi-Fi (wlan0), or an LTE (wwan0) network interface. | | MAC Address | Physical address of the network interface. | | IP Address | Logical address assigned by software to the network interface. | | Address Family | inet means that IPv4 traffic is run through the interface, while inet6 means that IPv6 is run through it. | | Type | Address space of the network. There are two types:
* *AddrTypePrivate* - The network interface can interact with any other network because the IP address has global scope. * *AddrTypeLinkLocal* - The IP address is only valid on local network segments. IPv6 requires a link-local address on every network interface. | ## Serial Interfaces | **Label** | **Description** | | ---------------- | --------------------------------------------------- | | Name | The name of the device. | | Model | The model of the device. | | Manufacturer | The manufacturer of the device. | | Serial # | The serial number of the device. | | Speed (Baudrate) | The communication speed of the device, in baudrate. | ## Modem Interfaces | **Label** | **Description** | | --------- | ------------------------------------------------------------------------------------------------------------------------------- | | Status | The network area of the LTE modem. Home, for example, indicates that devices are all in close vicinity to the modem. | | Bars | The signal strength of the LTE modem. It ranges from zero to five. Zero means no signal, while five means a very strong signal. | | Network | The mobile network from which the modem communicates. | | IPv4 | The IPv4 address of the modem. | | IPv6 | The IPv6 address of the modem. | | IMEI | International Mobile Equipment Identity. A unique number that identifies mobile network devices. | | ICCID | Integrated Circuit Card Identifier. The SIM card serial number. | | APN | Access Point Name. Serves as a gateway for a mobile network to connect to another network or the public Internet. | ## CAN Interfaces | **Label** | **Description** | | ------------------ | -------------------------------------------------------------------------------- | | Interface | The name of the device. | | Set "open" | A check box that configures the selected device. | | Set "closed" | A check box that configures the selected device. | | Set "status reset" | A check box that configures the selected device. | | CAN Speed, Kbit/s | The high-speed baud rates from 40 Kbit/s to 1 Mbit/s, depending on cable length. | | UART Speed, baud | The maximum rate at which information is transferred. | [title] Add a New Site [path] Litmus Edge Manager User UI/Product Features/Sites/ You can add a site by navigating to **Litmus Edge Manager User UI** > **Sites**. **To add a Site**: 1. From the *Sites* pane, click the **Add** icon or click the **Add** box. The *New Site* dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/tZbNK4xVyF_aHqDVg9ci1_dshrah6z8w5k7mtwqtfgu2023-07-1710-15-50.png" size="100" width="2879" height="631" position="center" caption="Add Licenses" darkWidth="2879" darkHeight="631" showCaption="true" indent="2"} 2. From the *New Site *dialog box, enter the following details: - **Name** - **Description**: (Optional) - **Site Image**: (Optional) Click the camera icon and navigate to an image of the site. 3. Click **Save**. The Site image appears on the *Sites* pane. [title] Log [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/ Use the *Log *tab to review the activity for an edge device. For example, log entries show when an edge device was added or deleted. Updates to the edge device parameters are logged with relevant details. From the Log tab, you can select a date range and filter the log. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/QOqfamaIso0z_42nSaNQz_image.png "Log tab") [title] Add/Upgrade a Node-locked License to an Edge Device [path] Litmus Edge Manager User UI/Product Features/Edge Devices/Edge Device Details/License/ From the **Edge Device Detail**'s **License** tab, you can add a Node-locked license to an edge device or upgrade an existing Node-locked License. # Access the Edge Device Detail License tab **To access the Edge Device Detail license tab:** 1. Log in to Litmus Edge Manager. 2. Select the appropriate company and project. 3. From the Navigation panel, select **Edge Devices**. The *Edge Devices* pane appears. 4. Click an edge device **ID** link in the Edge Devices pane. The selected *Edge Device Details* page open with the **Info** tab. 5. From *Edge Device Details* page, select the **License** tab. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/W0_YampyxpHESp8_2KXmG_image.png" size="80" width="1920" height="914" position="center" caption="License tab" showCaption="true"} # Prepare to Add a License A license can only be added if there is no existing Node-locked license. **To prepare to add a license:** - From the Edge Device Details' *License* tab, scroll down, and click **Add License**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/kNLQyP41XSaOCcHQ3vtLF_image.png" size="80" width="1920" height="914" caption="Add License" position="center" showCaption="true"} The License user interface expands with the *Add a New License* section. By default, the *Online License Activation* tab appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/SUFzGG5xDTzl5Xec7Q8zr_image.png" size="80" width="1920" height="969" caption="Add License UI expands" position="center" showCaption="true"} # Prepare to Upgrade a License A license must exist before it can be upgraded. **To prepare to upgrade a license:** 1. From the Edge Device Details' *License* tab, scroll down, and for the license to be upgraded, click **Upgrade License**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/KZbPvSFvqutkkFCmgH8MO_image.png" size="80" width="1920" height="969" caption="Upgrade License" position="center" showCaption="true"} The License user interface expands with the *Upgrade License* section. By default, the *Upgrade License Online* tab appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/yowVPZVRoiJEHDLaJuC-h_image.png" size="80" width="1920" height="969" caption="Upgrade License UI expands" position="center" showCaption="true"} # Online Activation The process for adding a new license and upgrading an existing license are identical. The only difference is that for upgrading an existing license, the new post-upgrade license will replace the old pre-upgrade license. **To add/upgrade a license online**: 1. From the *Online License Activation/Upgrade License Online *tab, in the **Activation key** field, enter the 16-digit Activation key you've received from Litmus. 2. Click **Submit**. 3. If successful, the new license will be added to the Edge Device Details *License* tab user interface. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/nd4hJmjmQdUh2eCAJ9wpI_image.png" size="80" width="1920" height="914" caption="Successful Online Activation " position="center" showCaption="true"} # Offline Activation The process for adding a new license and upgrading an existing license are identical. The only difference is that for upgrading an existing license, the new post-upgrade license will replace the old pre-upgrade license. **To add/upgrade a license offline**: 1. From the *Offline License Activation/Upgrade License Offline *tab, in the **Activation key** field, enter the 16-digit Activation key you've received from Litmus. The Activation key must be a valid key for later steps of this process to operate successfully. 2. Click **Generate Request**. Under *Offline Activation Request*, an offline activation request string will be generated. 3. To the right of the offline activation request string, click **Copy to clipboard**. This will copy the offline activation request string. 4. Below the offline activation request string, click **License Portal **or **Open License Portal**. This will open a new browser tab titled *Licensing Portal*. 5. From the *Licensing Portal*, in the **Activation Request** field, enter the copied offline activation request string from Step 3. 6. To the bottom-left of the *Activation Request* field, click on the *I'm not a robot* **Checkbox**. 7. Click **Make License**. If the received Activation Key from step 1 is a valid key, the **Activation Result** text will display. 8. To the right of the **Activation Result** text field, click **Copy content to clipboard** to copy the Activation Result string. Once copied, click **Close**. 9. Return to the *Offline License Activation/Upgrade License Online *tab. In the **Offline Activation Key** field, paste the Activation Result string. 10. Click **Submit**. 11. If successful, the new license will be added to the Edge Device Details *License* tab user interface. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/nd4hJmjmQdUh2eCAJ9wpI_image.png" size="80" width="1920" height="914" caption="Successful Offline Activation " position="center" showCaption="true"} [title] Show Site Points [path] Litmus Edge Manager User UI/Product Features/Sites/ After creating a Site in the *Sites* pane, it can be then customized to map edge devices on the Site Image. The Site image will display a list of mapped site points (each point corresponding to an Edge Device), along with additional information on each of the site points. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/K1V0TWET6edR7RQWrj7o7_image.png" size="80" width="1920" height="914" darkWidth="1920" darkHeight="914" position="flex-start" caption="Show Site Points" showCaption="true"} # Next Steps - [Map Site Point](docId\:SoSJQ4OH866jpx6mej0Uo) - [Manage a Site and Site Points](docId\:GsNH7bBELH8hEkk3Kf95q) [title] Map Site Point [path] Litmus Edge Manager User UI/Product Features/Sites/Show Site Points/ You can map site points within a Site's *Show Site Points* page. # Before You Begin The selected edge device to be mapped to a Site must be online. # Map Site Point **To map an Edge Device as a site point**: 1. From a Site's *Show Site Points* page, click the **Add new Point** icon. The Device dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/zx3i-i40yuZbYAnix4FZE_rww4f5pjbzlce48c6ubtimage.png" size="100" width="1920" height="969" position="center" caption="Add new Point" darkWidth="1920" darkHeight="969" showCaption="true" indent="2"} 2. From the* Device* dialog box, click on one of the **Edge Device ID** to select a device to map. The Edge Device mapping point appears on the Site image. It is initially blue. A new row with the selected Edge Device ID will be added in the table below. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/8uKPVo3_vioWESSiqzO7O_sl4hwsrerjj8irvzxdcnyimage.png" size="100" width="1546" height="334" position="center" caption="Device dialog" darkWidth="1546" darkHeight="334" showCaption="true" indent="2"} 3. Notice the Edge Device mapping point. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/EgyZYJ-CPzmOoPs0XD1Vn_3sigufp8yal84xifmirwnimage.png" size="100" width="1920" height="969" position="center" caption="Blue Map Point" darkWidth="1920" darkHeight="969" showCaption="true" indent="2"} 4. From the *Site* image, click and drag the blue mapping point on the site map image where the device is actually meant to be physically located. Once moved, the mapping point turns green. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/hBjTnYF54PvqrA1wdweJ0_xdsemb0thxgwur42tgykhimage.png" size="100" width="1920" height="969" position="center" darkWidth="1920" darkHeight="969" showCaption="false" indent="2"} 5. Click **Save**. The Edge Device is mapped at the point selected. [title] Users [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ The *Users *module allows you to manage the users, company teams, and project teams for Litmus Edge Manager. The User Management pane includes four sections: - **Administrator***: *Change the administrator password. - **Users**: Add, edit, or remove users. - **Company Teams**: Add and remove teams for a company, and add and remove users for a selected company team. - **Project Teams**: Add and remove project teams for previously added company teams, and assign roles of n/a, read or write to the selected project team. # Administrator ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/vJtA6oTyqe614tB5teXJk_image.png" size="80" width="1745" height="68" position="center" caption="Administrator account management" showCaption="true"} **** # Users Management You can add a new user in *Users* section. Users added in the *Users*** **section in the *Users*** **module are permitted to access and manage Litmus Edge Manager. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Kcr8jylib2Hp7WOSVhOcb_oqqdurp1mli9puuvprgokimage.png "Users Management") | **Action** | **Details** | | -------------------------------------- | --------------------------------------------------------------------------------- | | \[1] **Change Password** | Update password | | \[2] **Show filter** / **Hide filter** | Search by *User Name*, and *Email* | | \[3] **Create new user** | Create a new user | | \[4] **View User Name** | [Edit a User Profile](docId\:KIJgyCJC1HGIm8mW7dVRK) | | \[5] **Action menu** | - Edit Team: [Modify a Company Team](docId\:LDllqh5dtQNonPSuQynkX) - Remove | # Company Teams ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/4eeJZpiRLKLM_C3mER5Bi_-nbhnms3aa1hzmrlpiuyrimage-1.png "Company Teams") | **Action** | **Details** | | -------------------------------------- | --------------------------------------------------------------------------------- | | \[6] **Show filter** / **Hide filter** | Search by *Company*, *Team Name*, or *Users* | | \[7] **Create new company team** | Ensure you have added at least one company. | | \[8] **View Team Name** | [Modify a Company Team](docId\:LDllqh5dtQNonPSuQynkX) | | \[9] **Action menu** | - Edit Team: [Modify a Company Team](docId\:LDllqh5dtQNonPSuQynkX) - Remove | # Project Teams ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/JGzY2KvnHNvJnuzaG_YWC_image.png "Project Teams") | **Action** | **Details** | | -------------------------------------------- | ---------------------------------------------------------------- | | \[10] **Show filter** /** Hide filter** | Search by *Company*, *Project*, or *Team Name* | | \[11] **Create new Project Team** | Ensure you have added at least one company and one project. | | \[12]** View Team Name** | [Modify a Company Team](docId\:LDllqh5dtQNonPSuQynkX) | | \[13] **Action menu** | - Edit Team: [Edit a Company Team](docId\:LDllqh5dtQNonPSuQynkX) | [title] Experimental Features [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ Experimental features give you early access to select Litmus Edge Manager (LEM) functionality. Enable each feature independently under **Settings** > **Experimental Features**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/U9vfb3PdtoK6qS_rFLJYY_image.png" size="80" isUploading="false" width="1389" height="614" darkWidth="1389" darkHeight="614" position="flex-start" showCaption="false"} ## Edge events management Edge events management allows you to view events for the entire date range for a device over its lifecycle. See [Events](#) for more information. :::hint{type="info"} **Note**: You must enable Forward Events to receive Litmus Edge device alert events. ::: ## Asset management Asset management enables Digital Twins in LEM. A Digital Twin is a virtual representation of an asset or system that uses real-time data to model how a product or process performs. You can add or remove a Digital Twin model, add or remove tags for a model, and arrange the tags in a hierarchy. See [Digital Twins](docId\:Hvp_-8GHJdHgc7_sTBj-s) for more information. ## Litmus IQ Litmus IQ is an AI chat agent that accepts questions in natural language based on daily digest report data. For example, you can ask "How many edge devices are online?" or "What's the current disk usage and available space?". Before enabling, configure your AI backend under **Integration** > **Litmus IQ**. See [Litmus IQ](docId\:Ltvm8Gy2es0DyD1RgNQOk) for more information. [title] Manage Multiple Teams and Members [path] How-To Guides/Litmus Edge Manager User UI Guides/ In this guide, you will add projects, create teams, and assign roles to users. You will create two projects and assign **Read/Write** permissions to each team member. - **Read permission**: You can access and view all areas of Litmus Edge Manager, but you can't make any changes to existing configurations/settings. - **Write permission**: You can access all areas of Litmus Edge Manager and make changes to existing configurations/settings. # Before You Begin You must have the Admin role to do the following: - Add or manage a company from your Litmus Edge Manager. - Add a user and assign roles to team members. - See [Assign Admin Privileges ](docId\:xFOg2xRprqINGA9cLsZB-) for more details. # Step 1: Create a Company See [Add a Company](docId\:QS1mbPG-tWRCyAAWe5Iya). # Step 2: Create Projects within the Company You need to add two projects to see how to manage multiple teams and members for multiple projects. Refer to [Add a New Project](docId\:pfNzvF07t2woIpl4azl5_) to learn more. The screenshot below shows what the *Projects* page looks like with two added projects. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0S5tKV8rcL5fK18v12-T4_image.png "Adding two testing projects") # Step 3: Activate an Edge Device Add at least one Litmus Edge device to each project. This allows you to assign roles to users in the projects. See [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) to learn more. # Step 4: Create Teams You can add multiple teams based on the size and structure of your company. We add two *Teams *to demonstrate the scenario of managing multiple teams from Litmus Edge Manager.  **To create teams:** 1. Navigate to *Settings *and click the **COMPANY **tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/sqK-7d9Hkgl9AteZVFdE1_a.png "Settings Page in LEM") 2. Add your team's name in the **Team Name** input box. 3. Click the **ADD TEAM **button. You can find the newly created team in the *Company Teams* table. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/22_aVCv3m-afKfRlWjUvp_xoxox.png "Company teams table") 4. Repeat the steps above to add another team**.** ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/h9k_lNp49lbZ8VBLmiQuI_aaa.png "Company teams table with two teams") # Step 5: Add Users to Teams To add new team members, invite them through email if they are not already in the system. **To add new users to teams:** 1. From the **Select Team** dropdown box, select a *Team *(Team1 for this example). 2. Enter the *name *or *email *of the user you want to add to the team in the **User Name / Email** input box. 3. Click the **ADD USER** button. The *Invite user *dialog box appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ctzrBvl79pPg8NDBgoYw__d1.png "Add user to a team ") 4. Edit or confirm the user email address and click **SEND**. The* Team Members* table will display the new user details. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/N5QXU6rMC4MA_Xl1G8fTs_c.png "Invite user dialog box") 5. Repeat the steps above to add another user to a different *Team *(Team2). ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/NBIHYXISb5f7mBo3hgqEM_d.png "Team members table") The user's *Status *is currently **PENDING **and will change to **ONBOARD** after they accept the invitation. # Step 6: Assign Roles to Teams  You can assign *Read *or *Write *roles to your team members. **To assign roles:** 1. Navigate to the **PROJECTS **page in *Settings.* 2. Make the following selections from the *Project Teams* section: - **Select Project**: Select **TestProject1**. - **Select Team**: Select **Team1**.  - **Select Role**: Select the **Write **role. 3. Click **ADD **to complete the process. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/4Tl8nEJn67PdGRUfTqddg_warr.png "Assign different roles to teams") 4. From the dropdown menu labeled **Select Role, **select the **Read **role for *Team2***.** Click the **ADD **button to complete the process.  The *Project Teams *table will display the details of the assigned project roles. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/TvoO-yHFH7m9KSJzpVsEH_bb.png "Roles for first testing project") 5. Repeat the steps above for *TestProject2 *and assign different team roles as described earlier. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6rAnzdiyvN3sHV5UqGtY8_bbb.png "Roles for second testing project") # Step 7: Accept Invitations to Join Respective Team Ask the team members to accept the company and team invitation. After accepting the invitation, the user's status on the Litmus Edge Manager portal changes to **ONBOARD**. [title] How-To Guides [path] / [title] Email [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ This section covers configuring email settings within the Litmus Edge Manager (LEM) Admin Console to enable email notifications. # Accessing Email Settings To view and configure email settings, navigate to the **Admin Console **>** Settings** section and go to the **Email** tab. To begin configuration, ensure the **Enable SMTP **toggle is switched on. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/-6WMS-6WvGGT8sY9xsSSk_image.png) ## Email Configuration Parameters When configuring email settings, complete the following parameters: | Action | Details | | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | \[1]** Enable SMTP** | SMTP needs to be enabled to invite or add a project team member. | | \[2] **Network** | Provide the hostname or IP address of SMTP server. | | \[3] **Port ** | Specify the port number that SMTP server uses.
For example, **25 **for plaintext or **587 **for encrypted connections using TLS. For secure connections like Gmail, port **587** is typically used. | | \[4] **Start TLS ** | Enable this option if your SMTP server supports and requires the STARTTLS (Start Transport Layer Security) extension for initiating a secure connection.
This is commonly used with port **587**. | | \[5] **TLS Required** | If your SMTP server mandates a TLS (Transport Layer Security) encrypted connection, enable this option. | | \[6] **Bypass strict certificate validation** | Enable to specify a mail server as trusted when the server uses a self-signed or custom certificate. | | \[6] **Use Authentication** | If your SMTP server requires authentication (username and password), enable this option. Most modern SMTP servers require authentication.
* **(Use authentication-only)** **Enter Username: **If authentication is enabled, provide the username for SMTP account, typically the full email address. * **(Use authentication-only) Enter Password: **Enter the password associated with the SMTP username. | | \[7] **Properties > Send from email** | Specify the email address that will appear as the sender of emails from the LEM system.
This is a required field. | | \[8] **Properties > Send from name** | Enter the name associated with the sender's email address (e.g., Litmus Edge Manager). | | \[9] **Send Test Email** | After configuring the settings, click the **Send test email** button to verify the configuration.
* A pop-up window will appear, prompting a recipient email address. * Upon clicking **Send**, the system will attempt to send a test email to the specified address. * A notification will indicate whether the test email was sent successfully or failed. | :::hint{type="info"} **Important: **If an email account (e.g., Gmail, Outlook.com) has MFA enabled, an App password may need to be generated and used instead of a regular password. - **Gmail App Passwords:** To create an App Password for **Gmail**, follow the instructions provided by Google: [Sign in with app passwords](https://support.google.com/accounts/answer/185833?hl=en#zippy=%2Cwhy-you-may-need-an-app-password%2C%5B%E2%80%A6%5Dwith-microsoft-outlook%2Cremove-app-passwords). - 2-Step Verification must be enabled for the Google Account first. - **Outlook.com/Office 365 App Passwords:** For Outlook.com or Office 365 accounts with MFA enabled, an App password may need to be created. - Refer to the following resources for guidance: - [Evermap tutorial](https://evermap.com/Tutorial_AMM_AppPasswordOffice365.asp) - [Microsoft Support](https://support.microsoft.com/en-us/account-billing/how-to-get-and-use-app-passwords-5896ed9b-4263-e681-128a-a6f2979a7944) ::: [title] Clickhouse [path] Litmus Edge Manager Admin Console/Product Features/Integration/ The *Clickhouse Settings* pane in the *Integration*** **module provides you with all the tools needed to set up and manage the *Clickhouse* configuration. The* Clickhouse Settings* pane includes the following sections: - **Clickhouse Server**: Displays a list of connection URLs for the *Clickhouse ports*. This section includes the supported URLs that can be used to connect to the Clickhouse database, allowing you to enable and manage how clients can connect and retrieve data. The URLs are comprised of the IP address of the Litmus Edge Manager and ports (these ports are default and cannot be changed.): - 8123 for HTTP - 8543 for HTTPS - 9000 for Native - 9004 for MYSQL - **Users**: Displays a list of users that can access Clickhouse. You can add a user name and password, change the user's password, and remove the user. - **ACL**: Displays a list of users that can access a project database for Clickhouse. You can add an ACL for a project with a specific user. The entries display the company and project name, the database name, and the user name. You can remove an ACL entry. - **Explore**: Allows you to open the Tabix web interface. # Access Clickhouse UI **To access the** **Clickhouse UI: ** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Integration**. Integration's *Kafka* pane by default appears. 3. From Integration's navigation sub-panel, select **Clickhouse**. Integration's *Clickhouse* pane appears. Refer to the following actions you can take on Litmus Edge Manager Admin Console's *Clickhouse* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/2hSqOVuh6bj8hlBXTDChD_tsz-bilt2-ozhwone8l1timage.png "Litmus Edge Manager Admin Console: Clickhouse 1/2") ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/lWo8Z2LkI72YjY5g3Gpcj_6sxmfacmc6pvxul9jyvloimage-1.png "Litmus Edge Manager Admin Console: Clickhouse 2/2") | **Action** | **Details** | | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Change port status state** | Change the port status | | \[2] **Copy to clipboard ** | - Server URL | | \[3]** Action menu** | * **Edit: **You can add or remove up to three IP addresses to a network port interface. The first two IP addresses are shown next to the network port interface as well as information about any additional IPs. Editing or removing an IP address for a port interface causes the current IP to disconnect. * **Enable/Disable** | | \[4] **Show filter** /** Hide filter** | Search by *User Name*. | | \[5] **Create User** | Make a new user | | \[6] **Action menu** | - Change Password - Remove | | \[7] **Show filter** /** Hide filter** | Search by *Topic (Company / Project)*, *Database Name*, or *User Name* | | \[8] **Add ACL** | Once an *User Name* has been associated with a *Topic*, it will automatically generate a new *Database Name*. | | \[9] **Action menu** | * Remove | | \[10] **Open Tabix** | See [Visualizing ClickHouse Data with Tabix: A Step-by-Step Guide](docId\:A_sy8Z8lQ6kH-WnX0yfYK) | | \[11] **Copy to clipboard** | Topic | | \[12] **Copy ** | - Database name to clipboard | | \[13] **Copy to clipboard** | User Name | [title] Project Settings [path] Litmus Edge Manager User UI/Product Features/LEM Settings/ A project represents an individual plant that a company operates. Projects contain the edge devices required for plant operations and maintain separate team access privileges from company-level teams. **Project Settings** provide a centralized location to configure data storage format, backup retention, metrics sync intervals, time zone, team access, MQTT connectivity, and the message schema used by connected devices. # Why This Matters Each plant may have different network environments, data requirements, and operational teams. Project-level settings let you configure these independently by plant without affecting other projects in the same company. # Core Components Project Settings are organized across four tabs: | Tab | Purpose | | ------------------ | --------------------------------------------------------------------------------- | | **Settings** | Operational configuration: storage format, backups, metrics, incidents, time zone | | **Members** | Team assignment and access privileges for the project | | **Credentials** | MQTT connection details, SSL certificates, topics, and ACL | | **Message Schema** | JSON schema for messages published by connected devices | # Operational Model ## Backup Retention LEM retains the most recent backups per edge device. The default retention count is three backups per device. ## Metrics Sync Interval Configure how frequently LEM polls edge devices for metrics. You can: - Set a project-specific sync interval (in seconds) in **Enable Edge Device Metrics Sync**. - Defer to the interval defined in individual edge devices by selecting **Use instance's edge device metrics sync settings**. # Roles and Permissions - **Team access**: Assign company-level teams to the project from the **Members** tab. Team definitions are managed in [Company Settings](docId\:XwUuYveHjgIbb0bYwlwSt). - **MQTT access control**: The **Credentials** tab manages credentials, custom topics, and ACL entries that control which clients can publish to or subscribe from project topics. # Project Settings Use the **Settings** tab to configure the project name and description, edge device data storage and backup settings, metrics reporting intervals, incident resolution behavior, and time zone. You can also remove a project from this tab. ## Project Modify the project name, and add or modify the project description. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/G1RPuCL5D8Z0CAwiM0_CB_image.png" size="80" width="1769" height="228" position="flex-start" caption="Settings: Project" darkWidth="1769" darkHeight="228" showCaption="true"} ## Edge Device Data Storage You have the option of storing edge device data in ClickHouse. You can store raw data or OMA (Open Mobile Alliance) data. - **OMA data**: OMA data has been deprecated from Litmus Edge and Litmus Edge Manager, but this option is available for backwards compatibility. We recommend selecting **RAW data**. - **RAW data**: We recommend using this option. To visualize data in Grafana, you must select **RAW data**. See [Grafana Dashboards](docId\:YTC1N5pOOjR1elW34jQmF) and [Visualize Child Device Data Using Grafana](docId\:cY2MwkiuvJ2nvNBZhaotC) to learn more. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/N0Phg9B7RCZNh8CgxucSE_image.png" size="100" width="1241" height="223" position="flex-start" caption="Edge Device Data Storage section" indent="2" darkWidth="1241" darkHeight="223" showCaption="true"} ## Edge Devices Backups Configure the backup retention policy for edge devices. By default, Litmus Edge Manager stores the three latest backups per edge device. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/H4GGmmo5GvcN3PdsoVxXQ_image.png" size="80" width="1241" height="193" position="flex-start" caption="Edge Devices Backups section" darkWidth="1241" darkHeight="193" showCaption="true"} ## Edge Device Metrics Sync Interval Edge Device Metrics Sync controls how often Litmus Edge Manager polls connected edge devices for metrics data. Adjusting the interval lets you balance reporting frequency against network and performance constraints. A shorter interval provides more granular visibility into edge device behavior. A longer interval reduces network load in bandwidth-limited environments. ### Sync Interval Priority The sync interval can be configured at three levels: device, project and instance. By default, lower-level settings take priority: - The device sync setting overrides the project setting for that device. - The project sync setting overrides the instance setting for all devices in the project. You can also override these priority settings: - At the device level by choosing to use the project's metrics sync settings (see [Manage](docId\:BoOFh2bJOlfpger0QymmF)). - Here at the project level by enabling **Use instance's edge device metrics sync settings** (see [Management](docId\:VzYNhoUsLtjETO0F1aFa1)). :::hint{type="info"} **Note**: **Edge Device Metrics Sync Settings** is available for Litmus Edge Manager version 2.26.1 and later. ::: ### Set the Edge Device Metrics Sync Interval The default interval is 30 seconds with a valid range of `30` to `604,800` seconds (1 week). ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3GY702hq6YEhqoSXWSlyK_image.png" size="80" width="1461" height="278" position="flex-start" darkWidth="1461" darkHeight="278" showCaption="false"} Do any of the following: - Use the **Enable Edge Device Metrics Sync** toggle to enable or disable synchronization of metrics. - Update the sync interval for the project by providing a new value in **Enable Edge Device Metrics Sync**. - To instead use the interval defined by the instance, select **Use instance's edge device metrics sync settings**. - Manually trigger a synch by clicking **Fetch Latest Data**. ## Timezone Select the time zone for your project. You can remove the time zone and reselect the time zone. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ZKbsTNIpo0XQ_SbnfATBM_image.png" size="80" width="1400" height="150" position="flex-start" caption="Settings: Timezone" darkWidth="1400" darkHeight="150" showCaption="true"} ## Remove Project Remove the selected project. Removing a project cannot be undone. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/HvG8eoP3hmM4TnPCFnXAU_image.png" size="80" width="1405" height="91" position="flex-start" caption="Settings: Remove Project" darkWidth="1405" darkHeight="91" showCaption="true"} # Members Tab ## Teams Select a company-level team, including role, for the selected project. Available options for a company-level team are based on teams you added in the Company Teams section in **Company Settings** > **Company** > **Company Teams** section (see [Company Settings](docId\:XwUuYveHjgIbb0bYwlwSt)). ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/J7mbBgGlMd0IEUsX0klx-_2023-07-2112-40-08.png "Settings: Members tab") # Credentials Tab ## Connection Copy any of the server URLs listed in the connection list. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/OnP9A9fOj5OX-AT6PtC3w_image.png" size="80" width="1692" height="263" position="flex-start" caption="Litmus Edge Manager User UI : Settings : Credentials tab : Connection" darkWidth="1692" darkHeight="263" showCaption="true"} ## MQTT Server SSL Certificate View, copy, or download MQTT server certificate. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/WEtdeC6XeSqsNNuvmBDWk_image.png "Credentials tab: Web Server SSL Certificate") ## Web Server SSL Certificate View, copy, or download Web server SSL certificate. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/q0F3MZ86xxIyo9N5K9Ixg_image.png "Credentials tab: Web Server SSL Certificate") ## Credentials Add, copy, or remove a credential. Credentials are used for accessing wildcard and custom topics. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/v_tM4WUGnEJIUB2sDwIHf_image.png" size="80" width="1688" height="233" position="flex-start" caption="Credentials tab: Credentials" darkWidth="1688" darkHeight="233" showCaption="true"} ## Topics You can add, copy, and remove a custom topic. You can copy a default topic. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/zcetwhCww3HREhZvzQVCF_image.png" size="80" width="1688" height="475" position="flex-start" caption="Credentials tab: Topics" darkWidth="1688" darkHeight="475" showCaption="true"} There are three preloaded topics credentials: - To send the data - To send request - To receive responses ## ACL You can add or remove an access control for a topic associated with the selected project. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/14DiUkV__2sMoGZI20QdI_image.png" size="80" width="1686" height="529" position="flex-start" caption="Credentials tab: ACL" darkWidth="1686" darkHeight="529" showCaption="true"} # Message Schema Tab From the *JSON *section, you can view and download the JSON schema of messages from devices that publish to the MQTT data topic. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/9d1ZdvBXhKTBCjiKvtGbC_image.png" size="80" width="1920" height="969" position="flex-start" caption=" Settings: Message Schema " darkWidth="1920" darkHeight="969" showCaption="true"} # Related Topics - [Company Settings](#) - [Management](#) - [Grafana Dashboards](#) - [Visualize Child Device Data Using Grafana](#) - [OMA LightweightM2M (LwM2M) Object and Resource Registry](https://technical.openmobilealliance.org/OMNA/LwM2M/LwM2MRegistry.html) [title] Docker Registry [path] Litmus Edge Manager Admin Console/Product Features/ The Docker module provides you with all the tools needed to have Litmus Edge Manager operate as a Docker registry. This allows you to manage all docker images. The Docker module acts as a toggle for two sub-modules: **Docker Images**: The Docker Images module allows you to upload images from the network or your hard drive, and pull them from the Docker registry. You can also view details for the image, copy an image pull command, and remove any images stored on the images pane. :::hint{type="info"} **Important**: The Docker Registry must be enabled in the *Registry* section of [Docker Settings](docId\:fNOt3P4u58-kh423wRE8K) before you can pull images from the Docker registry. ::: **Docker Settings**: The Docker Settings module allows you to view the Docker registry URL, copy the Docker registry, copy the login command, and add, update, and remove registry users. [title] Edit a Company Team [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/Users/ You can add team members to a team from the Company Teams section or the Project Teams section in the User module. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/5063Nc-u9fzi0g7RUNIU5_image.png "Modify Company Team") | **Action** | **Details** | | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Edit Team Name** | Update the team name | | \[2] **Save Team Name** | Save team's name | | \[3] **Show filter** / **Hide filter** | Search by *Company Name*,* Team Name* or *User Name* | | \[4] **Add Team Member** | Ensure you have added users. SMTP needs to be enabled from [Email](docId\:GcxRXKR3-oc_O9zqz7Jke) to invite or add a project team member. | | \[5] **Edit/View User Details** | - [Edit a User Profile](docId\:KIJgyCJC1HGIm8mW7dVRK) | | \[6] **Action Menu** | * Remove | [title] Create an Email-Alert Trigger for DeviceHub Device Status [path] How-To Guides/Litmus Edge Manager User UI Guides/Alerts Guides/ In this guide, you will configure an alert and a trigger to detect any unexpected disconnections of DeviceHub devices that connect to Litmus Edge Manager. Afterward, you will simulate a disconnection for one of the devices to trigger the alert. # Before You Begin - You will have to enable SMTP from the Litmus Edge Manager Admin Console. See [Email](docId\:GcxRXKR3-oc_O9zqz7Jke) to learn more.  - To connect your Litmus Edge instance to Litmus Edge Manager, see [Activate an Edge Device](#). A Litmus Edge instance needs to be activated in Litmus Edge Manager before it can trigger alerts. # Step 1: Add Device Follow the steps to [Connect a Device](docId:3eyAfPpweuVmBLCEy17sq). Select the Device Type **Simulator **and Driver Name **Generator**. # Step 2: Set Up an Email-Alert based Trigger In this step, you will create an email notification alert and then set up a trigger to use it. Please refer to the [Alerts](docId\:BWq6oBkuTNZgIJBIgQPBE) for further information. From Litmus Edge Manager, navigate to **Alerts** and follow the steps below.  ## Step 2a: Set Up an Email Alert **To set up an email alert: ** 1. From the *Alerts *pane, click the **Add new Action** icon. The *Add new Action* dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/jcIeQ5n7Ahq0K5lkrL8Pq_add-new-action-icon.png" size="80" width="1378" height="719" caption="Add new Action icon" position="center" showCaption="true"} 2. From the *Add new Action* dialog box, enter the following details: - **Action Template**: Select EMAIL. - **Action Name**: Enter an action name. - **Enter email**: Enter an email address that will receive the alert. - **Notifications Limit**: Enter 1. - **Interval**: Select *minute*. 3. Click **Add**. The newly created action appears in the *Action List*. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/12fxB2Jd2r2gu7ixNdevB_image.png" size="80" width="1554" height="496" caption="Creating a new email alert" position="center" showCaption="true"} ## Step 2b: Set Up a Trigger **To set up a trigger: ** 1. From the *Alerts *pane, click the **Add new Trigger** icon. The *New Trigger* pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/iR8l5AaljyD_E_uqcuXTG_aw.png "Add new Trigger icon") 2. From the *New Trigger* pane, configure the following sections: ### Trigger - **Name**: Enter a name for the trigger. - **Active**: Select the checkbox. - **Dashboard**: Select the checkbox. - **Description**: Enter a description for the trigger. ### Scope - Choose the **Edge Device** option and select the applicable Litmus Edge instance. ### Source - Select** Metrics **as the source of the trigger. - Click **Add **new rule. - **Select Alert template**: Select *DH device online status.* - Enter the value `60` for *Alert Delay, seconds*. ### Action - **Action List**: Select the action you previously created. - **Continuously**: Select the checkbox to send notifications continuously. - **Notification Period, minutes**: Enter 1. 3\. Click **Save**. The alert trigger appears in the *Trigger *List. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/upvfX3S2xUd7W4-gKdjqv_image.png "Creating a device status email trigger") # Step 3: Simulate a Disconnection From Litmus Edge, you will simulate a disconnection with Litmus Edge Manager. **To simulate a disconnection:** 1. Log in to Litmus Edge. 2. From the Navigational panel, select **DeviceHub.** The *Devices *pane appears**.** 3. To disconnect, click the **Stop Device** button located on the *device *tile that is currently connected. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/N14Ct1UcAf_cHDxig9BKF_ax.png "Disabling the Connected Device Status") # Step 4: Verify Successful Trigger and Alert From Litmus Edge Manager, you will verify the simulated disconnection. **To verify the trigger and alert:** 1. Log in to Litmus Edge Manager. 2. Select the appropriate company and project. The *Dashboard *pane appears for the project. 3. From the navigation panel, select **Incidents**. The *Incidents *pane appears. Confirm you see the incident listed. The email address that was configured for the alert will also receive the respective alert email. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/xgsr3FAuSuzvpV1pDZx2R_image.png "Alert Email") [title] Event ID for User Alert Triggers [path] Litmus Edge Manager User UI/Product Features/Alerts/ All Litmus Edge events can be classified as one of the five following components: - cc - Integrations - mp - Marketplace - dh - Device Hub - auth - Authentication - dm - Device Management Each of these five components contain a list of specific Litmus Edge events. These specific and classified events are Event IDs. When setting up a user alert trigger, you can choose from one of the five components above, then select an Event ID (a specific Litmus Edge event). Once selected, the user alert trigger will be customized to only trigger when the Event ID occurs. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Dw5m6T_nC5K-zkIenGlPV_image.png" size="80" width="1739" height="444" caption="Selecting EventID" position="center" showCaption="true"} \[1] **Select Component** \[2] **Event ID** When creating rules for the *Events* source, the following *Event ID*s are available: | **For this component** | **These Event IDs are available** | | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | cc - Integrations | - All - tags.removed - conn.created - conn.removed - tags.disabled - conn.disconnected - tags.added - conn.enabled - conn.create.failed - conn.disabled - conn.remove.failed - tags.enabled - conn.connected | | mp - Marketplace | * All * app.download.failed * app.created * app.deleted * app.exited * app.download.completed * app.failed * app.create.failed * app.restarted * app.download.started * app.delete.failed * app.started * app.stopped | | dh - Device Hub | - All - device.disabled - device.remove.failed - tags.remove.failed - device.updated - device.create.failed - tags.created - device.update.failed - tags.updated - device.connected - tags.create.failedtags.removed - device.enabled - device.removed - device.created - device.disconnected | | auth - Auth | * All * user.created * role.create.failed * role.deleted * user.delete.failed * role.assign.failed * login.lockdown * role.unassign.failed * login.succeded * role.delete.failed * role.asigned * role.created * user.create.failed * user.deleted * role.unassigned | | dm - Device Management | - All - backup.restore.warning - deactivation.succeeded - swupdate.failed - device.rebooted - deactivation.failed - swupdate.applied - diskspace.limit.exceeded.system - template.applied - activation.failed - backup.restored - backup.restore.failed - diskspace.limit.exceeded.user - activation.succeeded - template.apply.failed | [title] Step 7: Set Variables in Litmus Edge Manager [path] How-To Guides/Litmus Edge Manager User UI Guides/Apply a Parameterized Template During Activation/ Once the activation request is approved, the* Set Variables* dialog box appears. Enter values for the variables in each variable field, and then click **Apply**. :::hint{type="info"} **Note:** Please refer to the list of [country codes for ISO 3166](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) when choosing the appropriate **Country\_Code**. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/pbOVRjenjb0T6uvVOxWv2_image.png" size="70" width="628" height="676" position="center" caption="Set Variables dialog box" showCaption="true"} The *Stage Activation* icon under *Status *shows a green check mark, and then the *Stage Provision* icon under *Status *shows a green check mark. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0CjaIWEcVoXn9nKFVJN60_image.png "Activation Request List pane") # Next Step The device with a parameterized template has been activated. Next, we will [Verify Template Parameters are Applied to an Edge Device.](docId\:f6GpuMnlnPi6AOV436JIv) [title] Set Up Variables for an Application Release [path] Litmus Edge Manager User UI/Product Features/Marketplace: Catalogs and Applications/Application Releases/Add a Draft Application Release/ Launch variables can be customized for a draft release. These variables will later be presented as configurable parameters during Application deployment (See the *Step 2: Application Settings* section of [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw)). These variables can also be used when setting up a Component (for *Containers*/*Containers Advanced*) or used within a compose configuration file (for *Compose*). See [Set Up Docker Container Configurations for an Application Release](docId\:mebpl6tcgzj9NS2Cmk5cQ) for details. The steps for setting up variables for an application release with one of *Containers*, *Containers Advanced* and *Compose* are identical. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ItsBWSvk3-RqJUuhLuWQW_2023-07-2111-10-31.png "Variables") | **Action** | **Details** | | ------------------------------------------- | --------------------------------------------------------------------------------- | | \[1] **Show filter **/ **Hide filter** | Search by *Name*, *Description*, *Default Value* | | \[2] **Add Variable** | You can add multiple variables. You can't add variables for a submitted release. | | \[3] **Edit this variable** | - You can't edit variables for a submitted application release. | | \[4] **Delete this variable** | You can't delete variables for a submitted application release. | ## More on Add Variable ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/woFWfnPqKzzT03GJcJ3-8_image.png" size="80" width="1166" height="431" caption="The Add Variable dialog box" position="center" showCaption="true"} - **Name**: Enter a name for a variable. The name will be used when referring to this variable in [Set Up Docker Container Configurations for an Application Release](docId\:mebpl6tcgzj9NS2Cmk5cQ). - **Label**: Enter a label for the variable. The label will be used to title the variable during application deployment. (See [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw) and [Deploy a Marketplace Application)](docId\:lbqQnNLNVFPZbk82ZlkSc). - **Type**: Select one of the following data types: - `string` - `int` - `enum` - **Default Value**: Enter a value for the variable. The entered value will be set as the variable's default value during application deployment. - **Description**: Enter a description for the variable. The description will be used to explain the variable during application deployment. - **Required **(Optional): Select the check box. This will force the variable to must have a value during application deployment. - **Private** (Optional): Select the checkbox. This will hide the variable value with asterisks during *Step 2: Application Settings* of [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw). This option is available for Litmus Edge Manager version 2.8.0 and later. ### More on enum For the `enum` data type, in addition to a default value, you can enter a list of values to the right of *Enum options. *Then, during application launch (See [Deploy a Marketplace Application](docId\:lbqQnNLNVFPZbk82ZlkSc)), the list of entered values will be presented in a dropdown list, where one of the entered values must be selected. If no values are entered here, then the variable value during application launch can be entered as usual as compared to selecting from a dropdown list. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3ZZCAqKG1ylA2DEWHhWTv_image.png" size="80" width="1173" height="659" caption="enum values" position="center" showCaption="true"} [title] Step 2: Add Variables to Parameterize Template in Litmus Edge Manager [path] How-To Guides/Litmus Edge Manager User UI Guides/Apply a Parameterized Template During Activation/ You can convert an existing template to a parameterized template. You can add variables and parameterize a template from the *Templates *pane. **To add variables to a parameterized template:** 1. From the *Navigation *panel, select **Templates**. The *Templates *pane for the project appears. 2. Click the **Action **menu next to a template that has been parameterized and select **Parameterize Template**. The *Template Details* pane opens, displaying the *Variables *and *Parameterized Template* panels. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3I4b1EosEkUQpIKkIQ77E_image.png "Templates pane for the project") 3. Click the **+** icon to add the following new variables: - **Name: **Enter **Device\_Name01**. - **Data Type:** Select **STRING** using the drop-down menu. - **Description:** Enter a description for the variable. - Click **Save**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/-pYvSYVk9DTT702DVo7Sc_image.png" size="70" width="624" height="772" position="center" caption="New Variable dialog box" showCaption="true"} 4. Repeat the above step to add **Device\_Name02 **and **Country\_Code **with *String *data types as variables. After adding new variables, the *Variables* pane will appear as shown below. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/4YbPrtt6w0V5DPGYIXg7Z_image.png "Variables pane with three variables") # Next Step After parameterizing a template and specifying the variables, you will next [Verify the Variables and Download the Parameterized Template JSON Configuration.](docId\:erQJt-TUzJ10I1jMJ9y1h) [title] Proxy Settings [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/Network/ You can configure the proxy settings by navigating to **Settings** > **Network** and clicking the **Proxy Settings** tab. # Proxy In a corporate environment, servers have no direct access to the internet. Security proxies are used to access servers. The* Proxy *section allows you to set up the use of a proxy server to access Litmus Edge Manager. :::hint{type="info"} **Note**: HTTP proxy is used for offline license activation and for alerts like Webhook and Slack ::: ## Before You Begin Make sure that a proxy server is created and available. Refer to the following actions you can take on the Litmus Edge Manager Admin Console's Network pane's *Proxy Settings* tab. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/d2cv0exIWCK-QxiY8KBFt_image.png" size="80" width="1920" height="866" position="center" caption="Proxy Settings Tab" showCaption="true"} | **Action** | **Details** | | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Enter HTTP host** | Example format (`xxx.xx.xx.216`) | | \[2] **Enter HTTP port** | Input HTTP port number | | \[3] **Enter HTTPS host** | Example format (`xxx.xx.xx.216`). Enter the HTTPS host and port if the proxy server operates in HTTPS. | | \[4] **Enter HTTPS port** | Enter the HTTPS host and port if the proxy server operates in HTTPS. | | \[5] **Toggle Use the same proxy server for HTTPS protocol** | If the HTTP host proxy also operates as HTTPS, enable this. | | \[6] **Enter Non-proxy hosts** | The format for the hosts are each host's DNS/IP address, separated by
commas.
**Example**: `127.0.0.1`,`localhost`,`192.168.1.1` | | \[7] **Test setting** | If the test succeeds, a black check mark displays. If the test fails, a red cross is displayed. | | \[8] **Save Proxy settings** | Save proxy settings to device | [title] Deploy Edge Applications to Multiple Sites Using Marketplace Catalog Sync [path] How-To Guides/Litmus Edge Manager User UI Guides/ You can use the Synchronization feature in the Marketplace Catalog to deploy a common list of edge device applications to multiple sites. This feature allows you to: - Centralize the deployment and availability of applications to all Litmus Edge (LE) instances, even if they are in air-gapped networks. - Create and distribute a new containerized application to multiple sites in a simple and scalable way. - Update a containerized application and send those updates securely to multiple sites. :::hint{type="info"} **Notes: **The Synchronization feature is part of the Marketplace Catalog inside the Litmus Edge Manager. It is available in Litmus Edge Manger 2.11.0 and later. ::: # Overview ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/JkoG6vADkQ1156-fFfccf_cascade-catalog-sync-v2drawio.png" size="80" width="565" height="345" position="center" caption="Cascade Catalog Sync Feature Overview" showCaption="true"} At a centralized location, the admin user who is responsible for distributing applications can create a primary catalog. Then, an end-user at an individual site can create a secondary catalog to synchronize with the primary catalog. An authorization process is used to establish a secure relationship between the two catalogs. The end-user can sync the secondary catalog with the primary to receive new or updated applications. After the synchronization process is complete, the secondary catalog will have identical applications and registries as the primary catalog. This feature ensures that all sites have access to the same applications that can be deployed to edge devices. As a result, local IT teams will experience fewer maintenance and troubleshooting issues, reducing overhead costs. # User Scenario: Syncing Application Updates to Global Manufacturing Sites A global manufacturing company has recently released Version 2 of its Analytics application. The application is part of the Company's suite of tools offered through the primary Marketplace Catalog and is critical for its customers' day-to-day operations. The company must ensure that all its clients worldwide, operating in different site locations, receive this update in a timely and secure manner. ## Primary Site - Headquarters (Canada) 1. The Company's IT administrator logs into the Litmus Edge Manager (LEM) with the Primary marketplace catalog at their headquarters located in Canada. 2. They upload the new version of the application into the Primary Catalog. 3. The administrator notifies all secondary catalog admins of available updates via email. ## Secondary Site - Customer Location (Japan) 1. The local IT staff at the Japan site receive a notification that a new application version is ready for synchronization. 2. The local IT staff logs into their local LEM with the Secondary marketplace catalog. 3. They manually initiate a sync with the primary catalog to pull the new application version. 4. The new version is then deployed across all local edge devices within the site. ## Outcome All LE devices at the Japan site are successfully updated to Version 2 of the Minio application, with minimal disruption to the site's operations. The Cascade Catalog Sync feature ensures that the updated application in the primary catalog is available to all global sites, maintaining consistency and efficiency across the company's vast operations. # Before You Begin - Ensure you have two working instances of LEM to set up a Primary (Canada) and Secondary (Japan) site. If you are ready for the user scenario, proceed with the first article listed below. **This process includes the following steps:** - [Step 1: Create Primary Catalog With List of Applications](docId\:qBOZmPgvAQv8-_JM5vYv_) - [Step 2: Create Secondary Catalog](docId\:ZO8hyYhJOLAEiH2tHM7-W) - [Step 3: Establish Secure Connection Between Primary and Secondary Catalog](docId\:s8JGesiGUpFPEHtDB_cfv) - [Step 4: Synchronize Secondary Catalog to Primary Catalog](docId\:ILFE6vhXxhgSqhuISb8Dl) - [Step 5: Deploy an Application from Secondary Catalog to Edge Devices](docId\:RHJyEcJ3Pt9WzLBsSpTMY) - [Step 6: (Optional) Update an Application Version](docId\:iQ9xXw9m86Q7KzajiMQQt) [title] Pull Image from Docker Registry [path] Litmus Edge Manager Admin Console/Product Features/Docker Registry/Docker Images/ When *Pull image from Docker Registry *is clicked, the following fields can be entered. See below for more information on each field. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/GbWCw3vUjow4r40JoRmKw_image.png" size="80" width="622" height="406" position="center" caption="Docker Images : Image Pull" showCaption="true"} | **Action** | **Details** | | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Enter Image Name ** | Input the name for image | | \[2] **Enter Tag** | The `latest` tag is used if this field is left blank. | | \[3] **Enter Docker Registry URL ** | - The URL can be left blank and if it's blank, the default Docker Registry (docker.io) is used.
If you have your own Registry, you can use its URL, username, and password to pull images. | | \[4] **Enter Username** | Enter the username | | \[5]** Enter Password** | Enter the password | | \[6] **View Password** | Display password if needed | | \[7] **Pull ** | Pull the image | [title] Docker Settings [path] Litmus Edge Manager Admin Console/Product Features/Docker Registry/ The *Docker Settings* sub-module allows you to enable Litmus Edge Manager as a secure, private Docker registry. This allows you to ensure that sensitive Docker applications can be shared and controlled within the Litmus Edge Manager environment, but are not stored outside of it. The Docker Settings sub-module allows you to view the Docker Registry URL, copy the Docker Registry, copy the login command, and add, update, and remove Docker Registry users. Docker Settings includes the following sections: - **Registry:** Copy the Docker registry URL and enable or disable the Docker Registry. - **Registry Proxy:** Enable or disable the Registry proxy authentication and state. - **Registry Users:** Enable or disable Authentication, add and remove a Docker Registry User, Change a Docker Registry User password, and copy the Docker Registry User login command. # Before You Begin Make sure you have permissions to the Docker Registry. Refer to the following actions you can take on Litmus Edge Manager Admin Console's *Docker Settings* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/xOAegetR1s_NEF_Mpxpvq_rk0l2akddfcf9itqq5i8qimage.png "Docker Settings") | **Action** | **Details** | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | \[1] **Enter Image Name ** | Input image name | | \[2] **Enter Tag** | Input the tag name | | \[3] **Enter Username** | Input the username | | \[4] **Enter Password** | Input the password | | \[5]** View Password** | Display the password | | \[6] **Save Password** | Save the password | | \[7] **Pull ** | Ensure you have permissions to the Docker Registry. When the Docker registry proxy is enabled, you cannot delete an image. | | \[8] **Toggle Authentication** | Ensure you have permissions to the Docker Registry. If authentication is disabled then registry credentials are not verified at the edge side. | | \[9] **Show filter** / **Hide filter** | Search by *Username*. | | \[10] **Create Docker User** | Authentication must be enabled first. The default user **mpcs\_em\_docker **already exists. If authentication is disabled then registry credentials are not verified at the edge side. | | \[11] **Copy to clipboard** | - login command | | \[12] **Action menu** | * Update * Remove | [title] Notification Settings [path] Litmus Edge Manager User UI/Product Features/Alerts/ From the *Notification Settings* section, you can add, modify, and view actions that is used by a trigger. The action sends a notification (Email, Slack, Webhook, Pagerduty) when a trigger is applied. # Access Notification Settings UI **To access the Notification Settings UI:** 1. Log in to Litmus Edge Manager. The *Dashboard *pane by default appears. 2. From the Navigation panel, **Alerts**. The *Alerts* pane appears. 3. From *Alerts *pane, select **Notification Settings**. The *Notification Settings *tab appears. Refer to the following actions you can take on the *Events & Alerts >* *Notification Settings *tab. The user interface below is for Litmus Edge Manager version 2.22.1 and later. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/tuWEXO8NepRstL67Jg5rL_image.png) | **Action** | **Details** | | -------------------------- | ------------------------------------------ | | \[1] **Action name** | Specify the name of the action. | | \[2] **Type of Action** | Select the action category or type. | | \[3] **Edit Action ** | Modify the details of the selected action. | | \[4] **Remove Action** | Delete the selected action from the list. | # Add a New Action Click the **Add a new action (+) **icon to open the dialog box to add an action category. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Ccfh1pWaPfAIck4e57d46_image.png" size="72" width="1146" height="472" position="center" showCaption="false"} Choose the Action Template (Email, Slack, Webhook, Pagerduty) and then complete the configuration to apply a trigger. [title] Triggers [path] Litmus Edge Manager Admin Console/Product Features/Alerts/ When you create a trigger, you create the trigger message contents, source for the trigger, and actions to start when the triggers is activated. When you create a trigger you define the: - trigger source. - trigger subject and message content that is sent to recipients. The subject and message fields can contain a combination of text and variables. - response action that occurs after the alert triggers. To specify the trigger source: 1. Navigate to **Alerts** > **Triggers**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1ts7q5-8S0YMnUwbvNpuh_screenshot-2026-01-09-111304.png" size="80" width="1800" height="565" position="flex-start" showCaption="false" indent="2"} 2. Click add trigger at the right of the page. 3. In **Source**, create trigger rules. 4. To create a rule based on an edge device instance metric: 1. Select **Instance Metrics**. 2. Select an alert template from the list. For example, select `Disk space is low`. 3. Select additional values to create the rule. In this case, select the minimum free disk space percentage and the time to wait between the event occurring and sending the notification, as shown below. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3xRmz4JzE1UjGquKmAlHN_image.png" size="80" width="1118" height="191" position="flex-start" showCaption="false" indent="3"} 5. To create a rule based on an edge device instance event: 1. Select **Instance Events**. 2. In **Component**, select the component source, for example, `Project`. 3. In **Event ID**, select an event ID trigger. For example, select from `project.deleted`, `project.created`, or `project.updated`. Next create the trigger message To create the trigger message: 1. In the **Trigger** section: 1. Provide a trigger name and description. 2. In **Subject**, create the notification subject by entering text and selecting one or more variables. 3. In **Message**, create the notification message by entering text and selecting one or more variables. Next, specify the response action that occurs immediately after the alert triggers. To specify the trigger action: 1. In **Actions**, select an action from the action list. 2. To specify that the notification is delivered repeatedly, select **Continuously** and define the notification frequency in minutes. 3. Click **Save**. [title] Git Provider [path] Litmus Edge Manager Admin Console/Product Features/Integration/ Litmus Edge Manager (LEM) supports native integration with Git providers such as GitHub, GitLab and Azure DevOps. This integration enables organizations to manage Edge templates using standard Git workflows, ensuring version control, auditability, and centralized governance. The Git Provider integration allows LEM to: - Store and version template files in a Git repository - Automatically synchronize template updates of Edge devices to Git - Track template changes across companies and projects - Maintain a consistent configuration baseline across distributed deployments ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Bu01wJ2HxZb-PbP99pfOH_image.png) This diagram shows how template synchronization occurs from edge devices to LEM and to your Git provider. :::hint{type="info"} The current implementation operates in one-directional manner and is intended primarily for audit and tracking purposes. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/jwAq0GUdKSiCZFoFvf4yw_git-integration-feature-2.png" size="80" width="22326" height="11239" position="flex-start" showCaption="false"} ## Prerequisites The configuration requires: - Administrative access to Litmus Edge Manager Admin Console - A valid SSH GIT URL (for example, git\@github.com\:org/repo.git) - An ED25519/RSA-SHA2-512 public key generated by LEM - A deploy key with write access added to the Git repository ## Synchronization Model LEM supports the following synchronization mechanisms: - Synchronization on a schedule: - Hourly - Daily at 00:00 UTC - Weekly on Monday at 00:00 UTC - Monthly on the 1st at 00:00 UTC - Synchronization triggered during edge device backup - Synchronization that you triggered manually ## Error Handling and Validation LEM performs validation and provides actionable error messages for: - Valid SSH keys - Whether the repository is accessible - Write permissions - Template schema compliance - Detecting sync conflicts ## Security Considerations - Authentication uses ED25519/RSA-SHA2-512 SSH keys - Deploy keys are scoped to a single repository - Write access is required in the Git Provider for LEM to commit changes - No credentials beyond the SSH keypair are stored ## Best Practices - Use a dedicated private repository for Edge templates - Restrict deploy key permissions to the minimum required scope - Apply branch protection rules for production environments - Use scheduled sync for predictable updates - Use manual sync for validation and testing # Configuration workflow The following workflow shows how you set up Git Provider. :::hint{type="info"} **Note:** Also see the [How to Setup Git Provider Integration](docId\:lrbAPAbg_jke-fuTAXF-j). ::: **Setup a GitHub repository** 1. In GitHub, create a new private repository. 2. Record the repository name. **Configure Git Provider in LEM** 1. In LEM, navigate to **Integration **>** Git Provider**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/5_q9UpyHFiV5ihsLqsuO6_image.png" size="80" width="1354" height="523" position="flex-start" showCaption="false" indent="2"} 2. Select the Git provider (GitHub, GitLab, or Azure DevOps). 3. Enter the **SSH URL **from the private repository that you created with the following syntax: `git@github.com:github-name/github-repo.git` 4. Copy the generated **SSH Public Key**. 5. Add the public key to the repository. For example, in GitHub add the public key to the Git repository as a **deploy key **with `write access`. 6. In LEM, validate access to the repository. Confirm that the `Repository access successful` message displays. 7. Save the configuration. **Configure Project Tracking** You set tracking at the project level. 1. Navigate to **Edge Devices **>** Edge Git Integration**. 2. Set the synchronization frequency: hourly, daily, weekly, or monthly. Syncs occur at 00:00 (UTC) daily, weekly on Mondays, and monthly on the first day of the month. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/8Ea7h6HQttDxgOFaXT2oD_image.png" size="80" width="1917" height="673" position="flex-start" showCaption="false" indent="2"} 3. For each company and project, choose when syncs occur. To set syncs: - Based on the synchronization frequency that you set, select **Track**. - When the device is backed up, select **Sync on Backup**. 4. To run the synchronization manually, select **Run Manual Sync **from the **Actions** menu. Configure integration for edge devices at the company and project level in **Project Tracking**. View the number edge devices and synced devices, last sync and commit ID, and integration status. The following columns display in **Project Tracking**: | **Field** | **Description** | | ------------------- | ----------------------------------------------------------------------------------------------------------------- | | Company | Company to which the devices belongs | | Project | Project to which the devices belong | | Track | Enable to push changes to Git based on the selected synchronization frequency | | Sync on Backup | Enable to push changes to Git when the device is backed up | | Edge Devices | Number of devices in the project | | Synced Devices | Number of devices that have been synchronized | | Last Sync Time | The last time that a synchronization was performed from all edge devices in the current project to LEM | | Last Commit | Git commit hash which is a unique identifier representing a specific commit in a Git repository | | Status | Status of the integration: `NEW`, `WAITING`, `RUNNING`, `CANCELING`, `SUCCESS`, `ERROR`, or `CANCEL` | | Action | Options to enable or disable tracking on the predefined schedule, on device backup, or to run a manual synch | [title] Syslog [path] Litmus Edge Manager Admin Console/Product Features/Integration/ :::hint{type="info"} **Note**: The Syslog feature is available for Litmus Edge Manager 2.7.0 and later. ::: Litmus Edge Manager (LEM) supports automatic log forwarding to an external Syslog server. All LEM System Events (See *System Events* tab of [Events](docId\:OnS8mKWpVtKc93cOoRAKm)) are automatically forwarded. This enables you to collect the forwarded logs on the Syslog server for Security Information and Event Management (SIEM) systems. # Access Syslog UI **To access the Syslog UI: ** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Integration**. Integration's *Kafka* pane by default appears. 3. From Integration's navigation sub-panel, select **Syslog**. Integration's *Syslog* pane appears. Refer to the following actions you can take on Litmus Edge Manager Admin Console's *Syslog* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/7bnq0_qm1mVHMnXZTBuCx_2023-07-2112-49-45.png "Litmus Edge Manager Admin Console: Syslog") | **Action** | **Details** | | --------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | \[1] **Enable/Disable logs forwarding** | Enable/Disable logs forwarding
Allows you to toggle the status of log forwarding to the Syslog server. | | \[2] **Enter Syslog server host** | Specifies the hostname or IP address of the Syslog server for log forwarding. | | \[3] **Enter port (UDP)** | Configures the UDP port number used for sending logs to the Syslog server. | | \[4] **Send test message** | Sends a test message to the Syslog server to verify connectivity and functionality. | [title] Cloud [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ Litmus Edge Manager can be configured to store updates, backups, and other data in an external storage location. # Before You Begin Create a Google Service Account with a Google Cloud Project. Then, generate and retrieve a GCP service account key (`.json`) file. *** For Litmus Edge version 2.17.0 and later, you have two options for setting Cloud Credentials: GCP SA Key Authentication and GCP Workload identity federation (OIDC) # Service Account Keys and Workload Identity Federation Explained Review the following descriptions of service account keys and workload identity federation to determine which option is the best for your specific requirements. ## Service Account Keys Each Google service account is associated with a public/private RSA key pair. The Service Account Credentials API uses this internal key pair to create short-lived service account credentials, and to sign blobs and JSON Web Tokens (JWTs). This key pair is known as the *Google-managed key pair*. In addition, you can create multiple public/private RSA key pairs, known as *user-managed key pairs*, and use the private key to authenticate with Google APIs. This private key is known as a *service account key*. See [Service account keys](https://cloud.google.com/iam/docs/service-account-creds#key-types) to learn more. ## Workload Identity Federation Workload Identity Federation allows you to can grant on-premises or multi-cloud workloads access to Google Cloud resources without using a service account key. You may select to use this option because service account keys are powerful credentials, so they can present a security risk if they are not managed correctly. With identity federation, you can use Identity and Access Management (IAM) to grant external identities IAM roles, including the ability to impersonate service accounts. This approach eliminates the maintenance and security burden associated with service account keys. ### Workload Identity Pools A *workload identity pool* is an entity that lets you manage external identities. You will review and have the option to customize this parameter when setting up these credentials. ### Workload Identity Pool Providers A *workload identity pool provider *is the entity that describes the relationship between Google Cloud and your identity provider (IdP). Workload identity federation follows the [OAuth 2.0 token exchange](https://tools.ietf.org/html/rfc8693) specification. You provide a credential from your IdP to the [Security Token Service](https://cloud.google.com/iam/docs/reference/sts/rest), which verifies the identity on the credential, and then returns a federated token in exchange. See the following to learn more: - [Workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation) - [IAM roles](https://cloud.google.com/iam/docs/overview#roles) # Option 1: Configure GCP SA Key Authentication Complete the following steps to configure GCP SA Key Authentication. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/mt7dGevgubXY8R9vegZ6a_image.png) ## Step a: Set Cloud Credentials **To set cloud credentials with GCP SA Key Authentication**: 1. In the *Cloud Credentials* section, click **GCP SA Key Authentication**. 2. Click the **Generate key** button. A bash script with commands will be displayed. Click **Copy to clipboard** to copy the bash script. 3. Modify the following bash script's variables value as per your setup: - `GCP_PROJECT_ID` - `SA_NAME` - `SA_KEY_FILE_NAME` 4. Run the bash script on Google Cloud console. A file called `sa_key.json` (or whatever `SA_KEY_FILE_NAME`'s value was) should be generated. This is the GCP service account key file for the next step. 5. Click the **Upload Key** button and navigate to the GCP service account key (`.json`) file on your device. Likewise, you can also copy the file contents of the file into the *GCP service account key in JSON format* text box. 6. (Optional) Click the **Validate** button to verify service account key file contents. 7. Click **Save**. Attempting to *Save* will automatically perform a *Validate*. If the save is successful, the *Google Cloud Storage (GCS)* radio button will be available for *Storage Settings*. A green checkmark will display with a message confirming the file contents have been saved. ## Step b: Set GCP SA Key Rotation Policy :::hint{type="info"} **Note**: This is available for Litmus Edge Manager version 2.14.0 and later. ::: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1xDifSVhe9c1U6CQIEDCJ_image.png) Configure the rotiation interval, in days, that the GCP Service Account key is automatically rotated. If 0 is entered, key rotation is disabled. ## Step c: Set Storage Settings ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/p7zk5jhVzjJmu7MJDvBbt_image.png) You can configure the storage settings by using local storage or Google Cloud Storage (GCS). If you select **Local**, Litmus Edge Manager will use its own local data space to store data. A bucket name is not required. If you select **Google Cloud Storage (GCS)**, a bucket name is required, which is the name of a folder in the Google Cloud Storage file system. **To set Google Cloud Storage:** 1. Select **Google Cloud Storage (GCS)**. 2. Click the **Create bucket** button. A bash script with commands will be displayed. Click **Copy to clipboard** to copy the bash script. 3. Modify the following bash script's variables value as per your setup: - `GCP_PROJECT_ID` - `SA_NAME` - `BUCKET_NAME` 4. Run the bash script on the Google Cloud console. It will generate a GCS bucket and display the value of `BUCKET_NAME`. The default value for `BUCKET_NAME` is `litmus-development--data`. 5. Below the *Bucket Name* field, enter the **Bucket Name** from the step above. 6. (Optional) Click the **Validate **button to verify the Bucket Name. 7. Click **Save**. The connection will be validated. # Option 2: GCP Workload identity federation (OIDC) :::hint{type="info"} **Note**: The ability to configure GCP Workload identity federation (OIDC) is available for Litmus Edge Manager 2.17.0 and later. ::: Complete the following steps to configure GCP Workload identity federation (OIDC). Learn more about [Workload Identity Federation](https://cloud.google.com/iam/docs/workload-identity-federation). ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6VAepoS1Y8vvl5dCuq5iR_image.png) **To set cloud credentials with GCP Workload identity federation: ** 1. In the *Cloud Credentials* section, click **GCP Workload identity federation (OIDC)**. 2. Configure and review the following parameters. - **GCP Project ID**: Refer to your GCP Project ID. See [Locate the Project ID](https://support.google.com/googleapi/answer/7014113?hl=en) and [Creating and managing projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to learn more. - **GCP Project Number**: Refer to your GCP Project Number. See [Locate the Project ID](https://support.google.com/googleapi/answer/7014113?hl=en) and [Creating and managing projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to learn more. - **Workload Identity Pool Name**: A default value is provided that you can customize. - **Provider Name**: A default value is provided that you can customize. - **Service Account Name**: A default value is provided that you can customize. - **Edge Device**: This value can't be customized. You will need to manually grant IAM roles on the Google Pub/Sub topic connected to this device. - **Litmus Edge Manager instance**: This value can't be customized. 3. Click **Download JWK file**. 4. Click **Generate script**. 5. Copy and execute the script. 6. Manually grant the following roles on the relevant Google Pub/Sub topic that is connected to the principle Edge device (Edge Device parameter). See [Access Control with IAM](https://cloud.google.com/pubsub/docs/access-control) to learn more. - PubSub Publisher - PubSub Subscriber - PubSub Viewer 7. Click **Validate**. 8. If the validation is successful, save the configuration. If the validation fails, review the error details. For storage settings, the only option is *Local*. Litmus Edge Manager will use its own local data space to store data. Google Cloud Storage is not supported while using *GCP Workload identity federation* credentials. [title] Step 8: Verify Template Parameters are Applied to an Edge Device [path] How-To Guides/Litmus Edge Manager User UI Guides/Apply a Parameterized Template During Activation/ There are many types of variables that we can apply to a template. This guide uses the following verification procedure as an example. **To verify template parameters are applied to an edge device in Litmus Edge: ** 1. From another browser tab, log in to newly activated Litmus Edge device. 2. From the Navigation panel, select **DeviceHub **>** Devices**. The *Devices *pane appears. 3. Verify the device for which the template was applied and ensure that the variables entered in the *Set Variables* dialog box appear correctly. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/YbxJlsSrKIhnXxynrrggU_image.png "DeviceHub Devices Pane") 4. Next, navigate to **System **> **Network **> **Configure **to verify the template parameter for the Country Code. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/seiOSjiBPJYTaQAh9VEfM_image.png "System > Network > Configure pane") 5. You can also check the Country from the *Terminal User Interface (TUI) *of an edge device. Learn how to [Change Country in Access the Terminal User Interface](docId\:R1Lz44wFFv3H9Jg33NWlP). ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/YuKQm37G7bs9w950EhgK6_image.png "Terminal User Interface (TUI) of an edge device") [title] Prometheus [path] Litmus Edge Manager Admin Console/Product Features/Integration/ :::hint{type="info"} **Note**: The Prometheus feature is available for Litmus Edge Manager 2.10.1 and later. ::: Litmus Edge Manager (LEM) supports the integration of a Prometheus monitoring system for collecting metrics data. From this integration's metrics data, you may connect the Prometheus monitor system to a third-party client (such as Grafana) to retrieve, access, and use the metrics data for a more thorough analysis. Litmus Edge Manager also supports the ability to connect to an external Alert Manager. When successfully connected, the [Incidents](docId:81uhi0Waj080EuLYceOaf) alerts are sent to the external Alert Manager. This enables you to use an external Alert Manager of your choice to provide a more comprehensive alert management system. # Access Prometheus UI **To access the Prometheus UI: ** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: `https://[LEM IP address]:8446`. 2. From the navigation panel, select **Integration**. The *Kafka* pane by default appears. 3. From Integration's navigation sub-panel, select **Prometheus**. The *Prometheus* pane appears. Refer to the following actions you can take on the *Prometheus* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/KAYqplksIBM6ZlTjLBUI0_2023-07-2112-48-52.png "Integration : Prometheus") :::hint{type="info"} **Note**: If you are unable to connect to the Prometheus URL, ensure inbound port 9090 is open. ::: | **Action** | **Details** | | ------------------------------------------- | ------------------------------------------------------------------------------------ | | \[1] **Toggle Prometheus endpoint** | Enable or disable the Prometheus endpoint connection. | | \[2]** Copy Prometheus URL** | Copy the Prometheus URL for use in third-party applications. | | \[3]** Enter Alert Manager Address** | Input the address of the external Alert Manager for incident alerting. | | \[4] **Show filter** /** Hide filter** | Toggle the visibility of filtering options within the Prometheus pane. | | \[5] **Test Alert Manager** | Verify the connection to the external Alert Manager for successful alert management. | :::hint{type="info"} **Note**: Litmus Edge Manager must have a successful connection to a running Alert Manager at an external server (at the Alert Manager's address) for a successful test. ::: [title] Tokens [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ :::hint{type="info"} **Note**: The Tokens feature is available for Litmus Edge Manager 2.7.0 and later. ::: The *Tokens *module allows you to create, view, and remove long-term tokens that can access your Litmus Edge Manager companies and their projects. These tokens help facilitate better communication between a Litmus Edge Manager and its Litmus Edge instances. You can use the API to mass deploy and configure edge instances. These tokens are best utilized within a CI/CD script to manage Litmus Edge Manager and its Litmus Edge instances. Each token has the following configuration parameters: - **Token name** - **Time to live**: The expiration date of the token - **Scope: **The permissions the scope has and how many companies/projects the token can access - **Edge API Bridge** (available for Litmus Edge Manager 2.15.0 and later): Allows you to integrate multiple Litmus Edge REST APIs through a single Litmus Edge Manager endpoint. After creating the token, you can use it in the API through the custom field `X-AuthToken` in the HTTP header. For example: `X-AuthToken: zZA82pIo70xzsrwmSl1f0P6DSfvuZgo1` # Access REST API Documentation Access REST API documentation for Litmus Edge Manager in the [Litmus API Portal](https://api.litmus.io/). # Access Tokens UI **To access the Tokens UI: ** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Settings**. Settings' *Domain/SSL* pane by default appears. 3. From *Settings*' navigation sub-panel, select **Tokens**. Settings' *Tokens* pane appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/idiPaC-9RkW4vEXp7rXCk_image.png" size="80" width="1920" height="866" position="center" caption="Tokens UI" showCaption="true"} # Next Steps - [Add Tokens](docId\:yv5gGJYMRsqqEK4dbNEwn) - [Manage Tokens](docId\:XHm8S32uEHfGTYfVuql7W) [title] Apply a Parameterized Template During Activation [path] How-To Guides/Litmus Edge Manager User UI Guides/ You can apply a parameterized template to one or more edge devices during activation. # User Scenario In a manufacturing setting, you need to configure multiple edge devices for different locations that have similar attributes. For example, DeviceHub Devices are needed for one edge device, and the same DeviceHub Devices are needed for another edge device at a different site. To save time on manually configuring each attribute in every Litmus Edge instance, you can use the Parameterized Template feature in Litmus Edge Manager (LEM). This feature allows you to create a template of your edge devices with specific attributes and set the variables that affect devices. Then, you are asked to supply input values to these variables during the activation request confirmation from your LEM. For this guide, we require two DeviceHub Devices in our template. We will then parameterize our template with three variables: - **Device\_Name01: **A string variable to change the name of the first DeviceHub Device in Litmus Edge. - **Device\_Name02: **A string variable to change the name of the second DeviceHub Device in Litmus Edge. - **Country\_Code:** A string variable to change the Country Code of Litmus Edge. If you are ready for the user scenario, proceed with the first article listed below. **This process includes the following steps:** - [Step 1: Create a Template with Specific Attributes](docId\:dum2moplwElHfhKSncvyI) - [Step 2: Add Variables to Parameterize Template in Litmus Edge Manager](docId\:L9Hb3woVugLNldub90iRQ) - [Step 3: Apply the Variables and Download the Parameterized Template JSON Configuration](docId\:erQJt-TUzJ10I1jMJ9y1h) - [Step 4: Create a Basic Activation Configuration with Parameterized Template in Litmus Edge Manager](docId\:jzPhm4AiKUMCZe9HvzL-a) - [Step 5: Create an Activation Request in Litmus Edge](docId\:gwn-33G0VPJYSyIxoTfqj) - [Step 6: Approve the Activation Request in Litmus Edge Manager](docId\:CVo0Mhk6WBQBM6fyeVElD) - [Step 7: Set Variables in Litmus Edge Manager](docId\:Lqj2utpw90k8Ul3gsZCUU) - [Step 8: Verify Template Parameters are Applied to an Edge Device](docId\:f6GpuMnlnPi6AOV436JIv) [title] Digital Twins [path] Litmus Edge Manager User UI/Product Features/ Digital Twins uses data to create models that can predict how a product or process performs. It is a virtual representation of a physical object or system across its life-cycle. A Digital Twin uses real-time data to enable learning for improved decision making. :::hint{type="info"} **Note**: Digital Twins is an experimental feature which must be enabled from the Litmus Edge Manager Admin Console before it becomes visible in Litmus Edge Manager. See [Experimental Features](docId\:PtIJysv_x6gV1g0Z4oR2B) for more information. ::: # Access Digital Twins UI **To access the Applications UI:** 1. Log in to Litmus Edge Manager. 2. From the Company List, click **Asset Management** for a company. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6M5GXYWN54PIHAi_cJGpI_2023-07-2013-41-20.png "Select asset management") The *Digital Twin* *Models* panel appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/BkUrJeztxQfnA3ubYmB5M_image.png "Digital Twin Models") ## Next Steps The following operations are available for **Company List**: - [Add a Digital Twin Model](docId:9YfNBK2aeqsavZMosHVMp) - [Manage Digital Twin Models](docId\:Fat2jWNA6wEAMvyPkXi-o) - [Deploy Digital Twin Models to Edge Devices](docId\:hyW_gkgyU2viMnc0I8Nqg) [title] Notification Settings [path] Litmus Edge Manager Admin Console/Product Features/Alerts/ In **Notification Settings**, you can add, modify, and view actions that is used by a trigger. The action sends an email or webhook notification when a trigger is applied. # Add an Action You can add email or webhook actions. To add a new action: 1. Navigate to **Alerts** > **Notifications**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/hGVsNqF3_j_Gks_lXRvdm_image.png" size="80" width="1437" height="434" position="flex-start" showCaption="false" indent="2"} 2. Click the add a new action **(+) **icon to open the **Add Action** dialog. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/kBRKZld0zPjqzxjbLGLPU_image.png" size="80" width="1441" height="548" position="flex-start" showCaption="false" indent="2"} 3. To create an email notification: 1. In **Action Template**, select **Email**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/toKDjiQ_XnMCCBduhb3Qa_image.png" size="100" width="697" height="345" position="flex-start" showCaption="false" indent="3"} :::Paragraph{listStyleType="decimal" listStart="2" indent="2"} Provide the action name. ::: :::Paragraph{listStyleType="decimal" listStart="3" indent="2"} In **Recipients**, add the email addresses of the users who will receive the notification. ::: :::Paragraph{listStyleType="decimal" listStart="4" indent="2"} Specify the maximum number of notifications to deliver by time period in **Notification Limit** and **Interval**. ::: 4. To create an webhook notification: 1. In **Action Template**, select **Webhook**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/rqkxywnZDDSnPv8uYAFKo_image.png" size="100" width="700" height="404" position="flex-start" showCaption="false" indent="3"} :::Paragraph{listStyleType="decimal" listStart="2" indent="2"} Provide an action name. ::: :::Paragraph{listStyleType="decimal" listStart="3" indent="2"} In **Method**, select **Post**. ::: :::Paragraph{listStyleType="decimal" listStart="4" indent="2"} In **Webhook URL**, specify the URL to deliver the JSON payload to. ::: :::Paragraph{listStyleType="decimal" listStart="5" indent="2"} Specify the maximum number of notifications to push by time period in **Notification Limit** and **Interval**. ::: :::Paragraph{listStyleType="decimal" listStart="6" indent="2"} To test the webhook, click **Test Webhook** and click **Details** in the notification message to view the payload. ::: [title] Data Lifecycle [path] Litmus Edge Manager Admin Console/Product Features/ The *Data Lifecycle* module consists of features that interact with Litmus Edge Manager's disk space. It offers you the opportunity to see how the disk space is used (Statistics), archive and download disk space data (Management), and remove disk/archived data based on certain conditions (Purge Policies). The page has the following sub-modules. **Statistics**: Includes the Disk Usage, Disk Usage by data object, Data Cumulative chart, Top 10 Projects Chart, and Stats by Periods sections. From this sub-module, you can do the following: - View user and archive data - View disk usage by period - View disk usage by projects - Archive and purge data **Management**: Includes the Data Archive list. You can download archived data files and purge the archived data files from this sub-module. **Purge Policies**: Includes the Instance Purge Settings and Companies Purge Settings sections. You can add and manage instance and companies purge policies from this sub-module. # Next Steps - [Statistics](docId\:SUvgdkwr-7WY9lRvKLBqM) - [Management](docId\:dsJZJ4n3ksgiQlIabM-gY) - [Purge Policies](docId\:mrx9t44OhiNjrFgcEV_aZ) [title] Edge Password Policies [path] Litmus Edge Manager Admin Console/Product Features/Edge Devices/ The *Edge Password Policies* module allows you to modify current policies for connected edge devices and view the usage for which the policy is applied. Default policies are part of the system, and are added during installation or upgrade. You can create multiple policies from a default policy tailored to your environment by copying a default policy and then modifying the copy. You can make copies of any previously saved policy. Policies created in the Litmus Edge Manager Admin Console are available to your connected edge devices. You cannot delete the default policy. The Policies pane includes two sections: - **Password Policies**: Allows you to modify the default password policy or copy the default password policy, rename it, and modify it to specifications. Remove a copied password policy. - **Policy Usage**: Allows you to view the policy that is applied to the company and projects listed. View the number of edge devices for which the policy is applied. See [Policy](docId\:CMHGjEOLZn_qu_jlOjdBO) for more information on how to apply a policy for a specific edge device. See [Apply a New Password Policy to a Litmus Edge Device](docId\:mTClEE0NAvZ-4gSFhiSEw) to learn more about applying a new password policy. # Access Edge Password Policies UI **To access the edge password policies UI:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Edge Devices**. Edge Device's *Edge Software Update* pane by default appears. 3. From Edge Device's navigation sub-panel, select **Edge Password Policies**. Edge Device's *Edge Password Policies* pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6w9RArphcY3kM4PaIlm0r_image.png "Edge Password Policies") # Edit Password Policy Names and Descriptions The names and descriptions of edge device password policies as shown on the *Edge Password Policies* screen can be edited. **To edit password policy names and descriptions:** 1. On the *Edge Password Policies* page, hover the mouse cursor over the panel depicting the policy you wish to modify. A pencil icon appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/NcpUn1M41qpQMR6YYEs1n_2023-08-2209-40-18.png "Password policy edit button") 2. Click the pencil icon. The policy name and description dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/c8cIOXp3kZWQ4m7IxcihE_2023-08-2209-37-42.png" size="80" width="720" height="448" position="center" caption="Edit Password Policy dialog box" showCaption="true"} From this dialog box, the name and description of a given policy can be changed as desired. Click **Cancel **to discard any changes and click **Save** to save the changes made to the policy name and description. # Edit Password Policy Parameters Several password policy parameters can be edited on the *Edge Password Policies *page. **To access the password policy parameters menu:** - Click the panel of the password policy whose parameters you wish to edit. The following parameters for passwords can be set as policy in this menu: - **Minimum password length** - **Maximum password length** - **Auto generated password length** - **Minimum uppercase characters**: Minimum allowed number of uppercase characters in a password accepted by the password policy. - **Minimum lowercase characters**: Minimum allowed number of lowercase characters in a password accepted by the password policy. - **Minimum number of digits**: Minimum allowed number of digits in a password accepted by the password policy. - **Special characters**: The special characters users can include in a password accepted by the password policy. - **Minimum special characters**: Minimum allowed number of special characters in a password accepted by the password policy. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/SARJX7NknaG5le7so02ge_image.png "Password Policy Parameters panel") # Copy Password Policies Password policies can be copied. **To copy a password policy:** 1. Click the panel of the password policy you wish to copy. 2. Click **Copy **at the bottom right section of the panel. To view details on how to enable a policy in an edge device, see [Policy Management](docId\:RJcVMjGrq0jMwlTB2caHS). Once copied, you can make changes to the values in the policy and then save again. [title] Step 1: Create a Template with Specific Attributes [path] How-To Guides/Litmus Edge Manager User UI Guides/Apply a Parameterized Template During Activation/ Templates for edge devices may include devices, analytics, flows, and connectors. You can make selections for these categories when creating a template from edge devices. # Before You Begin - Activate an instance of Litmus Edge to create a template in [Step 1: Create a Template with Specific Attributes](docId\:dum2moplwElHfhKSncvyI). See [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB). - Add two DeviceHub devices to your activated instance of Litmus Edge. To learn more, please refer to [Devices](docId\:EV3UOz6GXwqVb7ydRX7BL). - Install a second Litmus Edge instance that is not activated to apply the parameterized template in [Step 5: Create an Activation Request in Litmus Edge](docId\:gwn-33G0VPJYSyIxoTfqj). *** **To create a template with two DeviceHub Devices:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. From the *Projects *pane, click a project tile. The *Dashboard *pane appears for the project. 4. From the *Navigation *panel, select **Templates**. The *Templates *pane for the project appears. 5. Click** Create Template from device** to import settings from your running instances of Litmus Edge. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CAGyYuioa3VvCuRGuuLbw_image.png "Create Template from device button") 6. From the *SELECT EDGE DEVICE* page, click the checkbox for the Litmus Edge instance with two DeviceHub Devices added. Then, click **NEXT**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0rxgVOKcmRABAECRgy0kT_image.png "SELECT EDGE DEVICE page") 7. From the *TEMPLATE OPTIONS* page, do the following: - **Configurations:** Check the boxes for the Litmus Edge components to include in the template. Make sure to select **Country **and **Devices **to complete the guide. - **Template Description: **Enter the description for template. - Click **CREATE**. The message *Template Created Successfully* appears at the bottom. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/61dkXqFdFkgA4tQYtHxvT_image.png "TEMPLATE OPTIONS page") # Next Step After creating a template, the next step is to [Add Variables to Parameterize Template in Litmus Edge Manager.](docId\:L9Hb3woVugLNldub90iRQ)**** [title] Grafana Dashboards [path] Litmus Edge Manager User UI/Product Features/ **Grafana** is an open-source platform application for data visualization, monitoring and analysis. Grafana is used to visualize data sent by a device's data store. It is primarily used in conjunction with InfluxDB. You can analyze, create and monitor KPIs using the Grafana dashboard. Access to the Grafana dashboard is defined using Keycloak authorization. See [Github](https://github.com/Vertamedia/clickhouse-grafana) for more information about example queries and panel information. To receive the `Admin` role on Grafana Dashboards, see the *Toggle Administrator role for Grafana* *section* of [Edit a User Profile](docId\:KIJgyCJC1HGIm8mW7dVRK). :::hint{type="warning"} **Important**: To visualize data in Grafana, you must select the **RAW data** option for the *Edge Device Data Storage* setting (**Litmus Edge Manager User UI** > **Company **> **Project **> **Settings **> **Edge Device Data Storage**). See [Project Settings](docId\:hmGSXiivMvDy4K43OanRv) and [Visualize Child Device Data Using Grafana](docId\:cY2MwkiuvJ2nvNBZhaotC) to learn more. ::: # Access Grafana Dashboards UI **To access the Grafana dashboard UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects *pane appears. 3. From the *Projects *pane, click a project or open the **Action menu** for a project and select **View**. The *Dashboard *pane appears for the project. 4. From the Navigation panel, select **Features**. The *Features* pane appears. 5. Click the **Grafana Dashboards** tile. The *Grafana Dashboards* pane appears in a separate browser tab. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/bGvPP8FpYD5kXVyAJ8cXB_image.png" size="80" width="1920" height="866" caption="Grafana Dashboard" position="center" showCaption="true"} # Default Grafana Dashboards Litmus Edge Manager-Grafana integration offers three default dashboards for acquiring analytics and more information about Litmus Edge instance. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CD4IHojFahE99m1_DMYgx_image.png" size="82" width="1920" height="794" position="center" caption="Grafana Dashboard Samples" showCaption="true"} - **Events**: monitor the event activity of Litmus Edge tags. - **Gateway details**: Monitor the hardware/network status of a Litmus Edge and its tags. Things to consider: - This dashboard updates the selector values only when it loads. This means that if the dashboard is already open, the list won’t refresh after renaming the friendly name of an edge device. - The list retrieves values from metrics obtained from edge device every 30 seconds (by default), so it's advisable to wait at least one minute after renaming before accessing the dashboard. - **PLC Tag Browser**: See [Visualize Child Device Data Using Grafana](docId\:cY2MwkiuvJ2nvNBZhaotC). [title] Integration [path] Litmus Edge Manager Admin Console/Product Features/ The **Admin Console **> **Integration **module has the following sections: - Kafka - Clickhouse - Prometheus - Syslog - DigiCert - Git Provider You can complete data integration from the entire Litmus Edge deployments into third-party applications using *Kafka*. **Kafka**: Includes the* Kafka Server*, *Users*, and *ACL* sections. You can do the following. - Download a certificate and copy the connection URLs for the *Bootstrap Server* and Kafka SSL Connection from the *Kafka Server* section. - Add and remove *Kafka* users from the *Users *section. - Change passwords from the *Users *section. **Clickhouse**: Includes the *Clickhouse Server*,* Users*, *ACL*, and *Explore* sections. You can do the following. - Edit, enable or disable, and change the port status for each available protocol from the *Clickhouse Server* section. - Add and remove *Clickhouse* users from the *Users *section - Change passwords from the Users section. - Add or remove a company or project for the *ACL* (Access Control List) from the* ACL* section. Authorization of topics is controlled by ACL. - Open a web interface to the Tabix Server for Clickhouse from the *Explore *section. **Prometheus**: Includes *Prometheus* and *Alert Manager* sections, available since Litmus Edge Manager 2.10.1. You can do the following. - Enable/disable *Prometheus* endpoint to expose an *Prometheus URL* for a third party client. - Add an external Prometheus *Alert Manager* address for Litmus Edge Manager to connect to. - Test the connection between Litmus Edge Manager and the external Prometheus *Alert Manager*. **Syslog**: Include the *Syslog* section, available since Litmus Edge Manager 2.7.0. You can do the following. - Enable/disable log forwarding to an external *Syslog* server. - Add an external *Syslog* server's hostname/IP address and port number - Test the connection between Litmus Edge Manager and the external *Syslog* server host. **DigiCert: **Includes the *DigiCert server URL*, *Enrollment Profile ID*, *Enrollment Passcode*, and *Validate *sections. Available since Litmus Edge Manager 2.22.1. You can do the following. - Set up the *DigiCert server URL *for communication with the *DigiCert IoT Trust Manager*. - Configure the *Enrollment Profile ID *for authenticating with the *DigiCert IoT Trust Manager*. - Generate and use the *Enrollment Passcode *for authentication between the *Litmus Edge Manager Admin Console* and the *DigiCert IoT Trust Manager*. - Validate the *DigiCert *integration settings to ensure successful communication with *DigiCert IoT Trust Manager*. **Git Provider:** Connect Litmus Edge Manager with an external version control system (GitHub, GitLab, or Azure DevOps) and store, manage, and track changes to Litmus Edge template files. # Access Integrations UI **To access integrations UI**: 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Integration**. The *Integration* pane appears. The user interface below is for Litmus Edge Manager version 2.10.1 and later. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/AeBHdCNRNxs7VFKOdRxJB_image.png" size="80" width="1758" height="648" position="center" caption="Litmus Edge Manager Admin Console: Integration" showCaption="true"} # Next Steps - [Kafka](docId\:M3iOVMsTPuLhmjpUpnLLR) - [Clickhouse](docId\:MD6NfAz8rrs1p_JWPaIm-) - [Prometheus](docId\:OAkGk5dDht9MCB_uCZurn) - [Syslog](docId:9NZiA2UGSkffvMjgIREJm) - [DigiCert](docId\:JD0z31mg3jF1iju1PrU3e) [title] Litmus Edge Manager Admin Console [path] / The Litmus Edge Manager (LEM) Admin Console is comprised of the following modules that help you administer Litmus Edge Manager. :::hint{type="info"} **Note:** To access the LEM Admin Console, you will need to access LEM from port 8446. Enter the following URL in a browser window: **https\://\[LEM IP address]:8446**. ::: | **Modules** | **Description** | | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [Dashboard](docId\:Sl5gAXltiR_U5aUa6y2oh) | Shows information about your companies, projects, and edge devices, including tables and charts related to your system | | [Data Lifecycle](docId:_t8wSy2JLq7LVIXhw3B6F) | Enables you to manage data archives, set data purge policies and view data statistics | | [Edge Devices](docId\:qD0fTbyerVQJxOM5IPApt) | [Edge Software Update](docId:3IevluZfOdrXAqOOpVT1n): Enables you to upload edge device software images to manage updates and upgrades for edge devices connected to Litmus Edge Manager
[Edge Device Templates](docId\:nNxhGGYezqqsdyajOkc8F): Allows you to upload and manage templates for companies, projects and edge devices
[Edge Password Policies](docId\:nZxdm63Ip1guJ_mQiN140): Enables you to modify policies for edge devices and view the policy usage
[Edge Remote Networks](docId\:aftGosdXRCw2Tz9d5Gtzg): Helps you remotely connect your edge devices to the available networks
[Node-Locked Licenses](docId\:c0-d2jkjFVytbWDoL9FRr): Provides a comprehensive summary of the usage of all Node-locked licenses for all companies and projects | | [License Server Management](docId:5U_hNNsaVs--E5HQJEQ0O) | Enables you to add and manage site licenses using an embedded license server | | [Integration](docId\:YI-zzNSsMxWw_FXcuiduB) | Provides data integration from any edge device deployment with third-party applications via Kafka, Clickhouse, Prometheus, Syslog, and DigiCert. | | [Docker Registry](docId\:igFscl1oSzPQXTQCmF02c) | Enables you to operate Litmus Edge Manager as a Docker registry for images maintained in the Litmus Edge environment | | [Settings](docId\:iy4TS5kq0gmAeYGVQjqRI) | Provides you with configuration functionality for Litmus Edge Manager
[Domain/SSL](docId\:MC8Z1bK3yWcKQq4-kupCv): Allows you to configure the domain name, SSL, and Edge Remote endpoint in Litmus Edge Manager
[Cloud](docId\:Tcs7sRvoORXHg5UzOyVSP): Allows you to configure store updates, backups, and other data in an external storage location
[Network](docId\:VVhYuAY0vwQsvIea6MF9Q): Allows you to configure Interface, DNS, NTP and Proxy settings for Admin console
[Email](docId\:GcxRXKR3-oc_O9zqz7Jke): Allows you to configure email server settings
[Licenses](docId\:D6OmBvcrDDBIvgqMZPx9h): Allows you to activate licenses, and shows information about your current licenses, features, and performance packs
[Users](docId\:m4I7KMG5bHSaTUxJNwMZ5): Enables you to you to manage access permissions for users, company teams and project teams
[Tokens](docId\:sHLyvAfrLOR7KkOopqV4N): Allows you to add, configure, view or delete tokens
[Upgrade](docId:-C0COf-HLIWthd8s3U2zp): Helps you upgrade software versions of Litmus Edge Manager
[Export/Import](docId:1VIPA5Py1DmcBoB5hDZMy): Enables you to export and import Litmus Edge Manager configurations and data
[Admin Console Backup](docId\:OpbSMI-B4XBzqTIePSHLn): Allows you to download and upload Litmus Edge Manager configuration files
[Experimental Features](docId\:PtIJysv_x6gV1g0Z4oR2B): Must be enabled in *Litmus Edge Manager Admin Console* to be visible. The following two experimental features are available: *Edge Events , Digital Twins*
[Management](docId\:dsJZJ4n3ksgiQlIabM-gY): Allows you to reboot your instance of Litmus Edge Manager | [title] Synchronization [path] Litmus Edge Manager User UI/Product Features/Marketplace: Catalogs and Applications/ :::hint{type="info"} **Note**: The Synchronization feature is available for Litmus Edge Manager 2.11.0 and later. ::: You can remotely synchronize Marketplace Catalogs located on different Litmus Edge Manager instances. To do this, you will execute the following key steps: 1. Create the primary marketplace catalog (and then add changes as desired) within a first Litmus Edge Manager. 2. Create a secondary marketplace catalog within a second Litmus Edge Manager. 3. Connect (via bootstrap) the secondary marketplace catalog to the primary marketplace catalog. Once connected, you can then synchronize the secondary marketplace catalog to be identical to the primary marketplace catalog. If desired, a Litmus Edge Manager can contain both the primary marketplace catalog and the secondary marketplace catalog. Review the [Deploy Edge Applications to Multiple Sites Using Marketplace Catalog Sync](docId\:Z8R_5mVU1pezFXVSeNhQu) how-to guide. :::hint{type="info"} **Note**: After a primary-secondary marketplace catalog synchronization, any further changes to the primary marketplace catalog requires additional primary-secondary syncs. Secondary marketplace catalogs will not automatically receive primary marketplace catalog changes. ::: # Step 1: Set Up Primary Marketplace Catalog You will create the primary marketplace catalog in the Litmus Edge Manager you want to store this catalog. This primary marketplace catalog will be the marketplace catalog that other secondary marketplace catalog(s) will synchronize and become identical to. **To set up the primary marketplace catalog**: 1. From the Litmus Edge Manager User UI, select the appropriate company and project. Then, navigate to **Features > Marketplace. ** The *Marketplace Catalog* opens in a new browser window. 2. Click **Add Catalog.** The *create catalog* dialog box displays.. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/A_mP68GXfWWSSEBEPqhfp_lem-primary-marketplace-catalog.png" size="80" width="1920" height="851" position="center" caption="Marketplace Catalog: Primary Marketplace Catalog" showCaption="true"} 3. Enter a name and optionally enter a description. 4. Select the *Synchronize* checkbox and from the *Select Role *drop-down list select **Primary.** 5. Click on the primary marketplace catalog you've just created. 6. (Optional) Inside the primary marketplace catalog, add the applications (and respective application releases) and registries that will be later synchronized to secondary catalogs. See Step 1-4 of [Add a Draft Application Release](docId\:pujQCF4jL0dUe8XjHsjmZ) and [Registry Management](docId\:M6yzedYRAwwYDnLDtOQlZ). ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/EQriAA4Il-W9Os-HMtSqZ_2023-07-2111-19-50.png) # Step 2: Download Primary Marketplace Catalog Bootstrap File After you have created the primary marketplace catalog and added relevant applications (and relevant releases) and registries, you will next download the primary marketplace catalog bootstrap file. **To download the bootstrap credential file**: 1. From the primary marketplace catalog's *Applications *pane, click **Synchronization**. The *Synchronization: Primary Catalog* pane appears. 2. From *Expiration within:* customize the desired duration for the bootstrap credential file. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Nts4uNvZOF2y2fL5AY6pz_2023-07-2112-20-36.png "From Expiration within: customize the desired duration for the bootstrap credential file.") 3. Click **Generate**. A `.bootstrap` file will be downloaded to your local computer. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ML1JVYExsD75hc5A_VMn8_2023-07-2112-22-36.png "Primary Marketplace Catalog: Synchronization: Generate Bootstrap File") # Step 3: Create a Secondary Marketplace Catalog After you have downloaded the `.bootstrap` file, you will next upload the bootstrap file from the previous step to at least one secondary marketplace catalog. You will do this in a *different* Litmus Edge Manager from the previous step. **To upload the bootstrap credential file to a secondary marketplace catalog:** 1. Repeat the steps to create a new catalog and create a secondary catalog. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/S5DL3W9HTdXyTbNbiLa8k_2023-07-2112-27-23.png "Marketplace Catalog: Secondary Marketplace Catalog") 2. From the secondary marketplace catalog's *Applications *pane, click **Synchronization**. The *Synchronization: Secondary Catalog* pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/KIUFH7kC2-yDSkG-eF_Lb_2023-07-2112-29-24.png "Secondary Marketplace Catalog: Synchronization") 3. Click **Upload**. Navigate to the `.bootstrap` file you downloaded earlier from the previous step and select it. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0HvFxkKM56ElAi7NvQmHR_2023-07-2112-30-52.png "Secondary Marketplace Catalog: Synchronization: Upload") 4. Confirm the *Certificate* information and click **Yes**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ni3Qh6sIwVXML3_yPqnmD_certificate.png" size="80" width="961" height="589" caption="Confirm Certificate" position="center" showCaption="true"} 5. You need to **approve **the connection request for the *Secondary Catalog* from the *Primary Catalog* pane. To do this, go back to the *Synchronization* page in the* Marketplace Catalog* of the first Litmus Edge Manager Instance. Then, select **Secondary Catalogs**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Fba4o05V0fgtqP-wUF_ck_image.png "Check connection request from LEM Marketplace Catalog") 6. You will receive a request from the secondary catalog to synchronize applications from the primary catalog. Click the **Actions **menu and select **Approve**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/wRv6GQoDpbJD27eOYgMRs_image.png "Approve the Request for Sync") 7. If successful, the upload process status will display as **Approved** in both the *Primary *and *Secondary Catalog Synchronization* pages. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/yNHVQBwGxRvuQCM_1kH_g_image.png "Approved Status in the Secondary Catalog Synchronization page") ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/yGLRayZ6z5DLTSOdunGWC_image.png "Approved Status in the Primary Catalog Synchronization page") 8. Navigate back to secondary catalog's *Synchronization: Secondary Catalog* pane, and click **Sync**. 9. After a successful sync, click **Applications** and **Registry Management** to verify the successful sync. # Step 4: Synchronize Secondary Marketplace Catalog to Primary Marketplace Catalog After you have uploaded the primary marketplace catalog's `.bootstrap` file to a secondary marketplace catalog, you can then synchronize the secondary marketplace catalog to become identical to the primary marketplace catalog's application (and their application release) and registries. **To synchronize the secondary marketplace and primary marketplace catalog:** 1. From a secondary catalog's *Synchronization: Secondary Catalog* pane, click **Sync**. If the Sync is successful, a success message will be displayed. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/BNUB7et8izUwNUDxUTa5M_lem-secondary-catalog-sync-and-confirm.png" size="80" width="1920" height="851" caption="Secondary Marketplace Catalog: Synchronization: Sync" position="center" showCaption="true"} 2. After a successful sync, click **Applications** and **Registry Management** to verify the successful sync. The secondary catalog will contain the same applications (and application releases) and registries as the primary catalog. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/7WuaQaTIOENW5X7Ils0QK_image.png" size="80" width="1920" height="851" caption="Secondary Marketplace Catalog: Applications and Registry Management" position="center" showCaption="true"} [title] Management [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ The **Management** page in **Settings **has two options: - **Reboot**: Restart the Litmus Edge Manager instance. - **Edge Device Metrics Sync**: Control how often Litmus Edge Manager polls connected edge devices for metrics data. :::hint{type="info"} **Note**: The Management module is available for Litmus Edge Manager version 2.15.0 and later. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/AnZO0tXa-QBlq-16q3TgH_image.png" size="80" width="1402" height="634" position="flex-start" darkWidth="1402" darkHeight="634" showCaption="false"} ## Reboot Litmus Edge Manager In **Manage**, click **Reboot**. ## Edge Device Metrics Sync Edge Device Metrics Sync controls how often Litmus Edge Manager polls connected edge devices for metrics data. Adjusting the interval lets you balance reporting frequency against network and performance constraints. A shorter interval provides more granular visibility into edge device behavior. A longer interval reduces network load in bandwidth-limited environments. ### Sync Interval Priority The sync interval can be configured at three levels: device, project and instance. By default, lower-level settings take priority: - The device sync setting overrides the project setting for that device. - The project sync setting overrides the instance setting for all devices in the project. You can also override these priority settings: - At the device level by choosing to use the project's metrics sync setting (see [Manage](docId\:BoOFh2bJOlfpger0QymmF)). - At the project level by choosing to use the instance's metrics sync setting (see [Project Settings](docId\:hmGSXiivMvDy4K43OanRv)). :::hint{type="info"} **Note**: **Edge Device Metrics Sync Settings** is available for Litmus Edge Manager version 2.26.1 and later. ::: ### Set the Edge Device Metrics Sync Interval The default interval is 30 seconds with a valid range of `30` to `604,800` seconds (1 week). Do any of the following: - Use the **Enable Edge Device Metrics Sync** toggle to enable or disable synchronization of metrics. - Update the instance sync interval by providing a new value in **Enable Edge Device Metrics Sync**. [title] Add/View a Remote Network [path] Litmus Edge Manager Admin Console/Product Features/Edge Devices/Edge Remote Networks/ You can add and view remote networks. - To add a new network, click the **Add **icon from [Edge Remote Networks](docId\:aftGosdXRCw2Tz9d5Gtzg). - To view/update a network, click the network name from [Edge Remote Networks](docId\:aftGosdXRCw2Tz9d5Gtzg). ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/OUPpQjHUFpq7OixJm13zL_image.png "Edge Remote Networks: Network View") | **Action** | | ---------------------------------------------------------------------------------------------------------------------------- | | \[1] Enter the network name. | | \[2] Select **IPv4 **or** IPv6**. | | \[3] Enter the subnet mask.
* IPv4 Example: `xxx.xxx.0.0/24` * IPv6 Example: `fd97:531a:ce26:ab11::/64` | | \[4] Enter the gateway address. | | \[5] Review the capacity for activated devices on the network (available for Litmus Edge Manager version 2.15.0 and later). | [title] Statistics [path] Litmus Edge Manager Admin Console/Product Features/Data Lifecycle/ The *Statistics *module primarily shows you how Litmus Edge Manager uses disk space. It allows you to view user/archive data, view disk usage by period, view disk usage by projects, and archive or purge data from this sub-module. The Statistics module includes the following sections: - **Primary Partitions Usage**: This section visualizes the current usage of primary partitions, including the total user data in GB, the percentage of user data used, and the percentage of free data space in GB. - **All partitions: **This section displays all instance partitions along with their current usage, including the total user data in GB, the percentage of user data used, and the percentage of free data space in GB. You can copy the path of a listed data object. - **Disk usage by data object**: Includes a pie chart with data objects depicted where you can hover over sections of the chart to view the disk usage for each data object in GB. - **Data objects: **A list of data objects showing the data objects' size, usage in percentage format, and path along with object name. - **Data Cumulative Chart**: Shows the Periods amount of disk usage for each month in bar chart format. - **Top 10 Projects Chart**: Shows the cumulative amount of disk usage for each project (up to 10 projects) in bar chart format. - **Stats by periods**: Includes a data list grouped by company and project organized by month. You can filter the list, and archive or purge a selected data item from the list. - **Stats by projects**: Includes a data list grouped by projects. You can only display the list and search/sort selected data items from the list. # Access Statistics UI **To access the statistics UI:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Data Lifecycle**. Data Lifecycle's *Statistics* pane by default appears. Refer to the following actions you can take on the Litmus Edge Manager Admin Console Data Lifecycle's *Statistics* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/h5RZYJcHrSC3Y6YtjUs2x_image.png) | **Action** | **Details** | | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **View data object disk usage** | [Marketplace: Catalogs and Applications](docId\:gqoGt_Szm8rz9UdPhl2NL) | | \[2] **Data Objects Table** | - **lem-upgrade: **Storage of LEM upgrade files. See [Upgrade](docId:-C0COf-HLIWthd8s3U2zp). - **minio-storage: **Storage of LE backup files, archived files and templates. - **prometheus-data: **Storage of Metrics data. See [Metrics](docId\:XZ4oKukesfg7rDekrLhPU). - **mpcs-docker-registry: **Storage of LEM Docker Registry files. See [Docker Settings](docId\:fNOt3P4u58-kh423wRE8K) and [Docker Images](docId\:H5XZoQNAk6PPCSzHZi0G-). - **clickhouse-data: **Storage of Clickhouse DB. See [Clickhouse](docId\:MD6NfAz8rrs1p_JWPaIm-). This is data related to connected Litmus Edge instances. This data is shown in more in details in *Stats By Periods*. - **mysql-data: **Storage of MySQL database. - **kafka-data**: Data used by Kafka service. See [Kafka](docId\:M3iOVMsTPuLhmjpUpnLLR) for details. - **dlm-archive**: Where archived data is stored. See [Management](docId\:dsJZJ4n3ksgiQlIabM-gY) for details. | | \[3] **Show filter** /** Hide filter** | Search by *Company*, or *Project*
Disk Usage statistics by period include:
- **Company**: The company name where the disk usage resides - **Project**: The project name where the disk usage resides - **Period**: The month the disk usage occurred. Disk space usage is partitioned in periods. Periods will always be one month. See below for more details. - **Size**: The amount of disk usage for the selected period in KB - **Action**: The menu that includes the ability to archive and purge and selected data | | \[4] **Action menu** | * **Archive Data: **When data is archived, the data is extracted from the Clickhouse database server and stored as a `.csv.gz` file. These files can be downloaded from [Management](docId\:dsJZJ4n3ksgiQlIabM-gY). | :::hint{type="info"} **Note**: - Each `.csv.gz` file is up to ten times the size of the data size (The data size that is shown in *Stats By Periods *section is actually a compressed size). Before you archive, ensure the Litmus Edge Manager has enough disk space to contain all the `.csv.gz` files that it will archive. Insufficient disk space will prevent the data from being archived. After archiving, review the list of archive files to ensure the archive operation was successful. ::: - **Purge: **This will delete the data from the Litmus Edge Manager. Purging data cannot be undone. # Period Explained Litmus Edge Manager keeps track of disk usage in partitions of months. The tracked disk usage is only for Clickhouse data (hence all archive/purge operations are applicable for Clickhouse data only). The disk usage amount is calculated either from the instance or each individual project. Each month of disk usage is defined as a period. For example, your Litmus Edge Manager has five projects. To calculate disk usage, each project will be categorized as one period for the same month. So Litmus Edge Manager will generate five periods for the same month, each period including one project. As an additional example, three months have passed. For the five projects above, each of them experienced some disk usage in those three months. So you will have 15 additional periods (five projects of disk usage \* 3 months). Periods are also categorized as previous or current. If the current system date is March 2023, then all disk usage by projects during March 2023 are current periods. All periods from February 2023 and before are previous periods. [title] Add a Digital Twins Model [path] Litmus Edge Manager User UI/Product Features/Digital Twins/ A model is a template that contains static and dynamic attributes, data transformations, and schemas. Instances are copies of a model configured with their own parameter values. After you create Digital Twins models, deploy the models or model instances to Litmus Edge. When you deploy, you: - Create a new model manually or from an import file. - Configure the model by defining static and dynamic attributes, data transformations, and schemas. - Deploy the model from Litmus Edge Manager to your Litmus Edge instance. - Deploy instances from Litmus Edge Manager to your Litmus Edge instance. You create Digital Twins models by navigating to **Asset Management** > **Models **for a company. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/fueF6FVADoiov_SWIpAJK_image.png" size="80" width="1598" height="618" position="flex-start" darkWidth="1598" darkHeight="618" showCaption="false"} See [Use Digital Twins to Contextualize Data](docId\:VDRP68HIwEA7iyLgo3eW7) for information on how to leverage Digital Twins. :::hint{type="info"} **Note**: Digital Twins requires a Scale or Growth Litmus license. ::: # Core Concepts ## Static attributes Static attributes are fixed metadata values you define on a model, such as `Manufacturer`, `Model`, or `Plant`. They act as placeholders and you set default values on the model and then override them for each instance. Use static attributes for information that describes an asset but doesn't change in real time. ## Dynamic attributes Dynamic attributes represent real-time data from your assets, such as temperature or pressure readings. Each dynamic attribute has a data type (JSON, boolean, array, string, or number) and a topic that tells Litmus Edge where to read the data from. You can use topic expressions with parameter placeholders to define topics that vary per instance. :::hint{type="info"} **Note:** Dynamic attribute data type values are stored and returned in lower case. ::: ## Transformations Transformations convert raw data published on a topic into a cleaner, more useful format before it reaches northbound systems. You can use JSON transformations to filter specific key-value pairs, or JSONata transformations for more complex logic like conditional outputs or computed values. Transformations are defined at the model level and applied to individual dynamic attributes. ## Schema A schema defines a custom structure for organizing the model's attributes into a hierarchy. You build the schema by grouping static and dynamic attributes under named nodes. Schemas make it easier for downstream systems to consume your Digital Twins data in a predictable shape. # Viewer and Administrator Roles Visibility of edge devices is limited to the companies that you have access to. The actions that you can perform also depends on your asset management role (defined in Litmus Edge Admin Console). You are also assigned one of the following roles: - The **Viewer** role allows view access to Digital Twins. - The **Administrator** role allows full access to Digital Twins. # Create the Model You have two options for creating the model. You can create a new model or import a model as a JSON file. ## Create a New Model **To create a new model:** 1. From the companies list, navigate to **Asset Management** > **Models**. 2. From the *Models *pane, click the **Create a model **tile. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/C0i2SBCoLNH048S36HysR_image.png" size="80" width="1598" height="618" position="flex-start" darkWidth="1598" darkHeight="618" showCaption="false" indent="2"} 3. From the **Asset** drop-down, select a model type. 4. Enter the name of the model in the **Name** field. 5. Optionally, enter a short description of the model in the **Description** field. 6. Click **Add**.**** A new model tile appears in the *Models *pane. ## Import an Existing Model You can import a model as a JSON file. To import an existing model, click **Import Model**, select a `.json` file, and click **Open**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/KVU8A8_eQgOvTzgKE3UmG_image.png" size="80" width="1598" height="618" position="flex-start" darkWidth="1598" darkHeight="618" showCaption="false"} ## Model Versions When you create a model, the model version starts at v.0. The version number increments when you save the model. The version number displays in the: - Model tile. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/LYeur2HtDhgxPUw6u68Rc_image.png" size="50" width="344" height="180" position="flex-start" darkWidth="344" darkHeight="180" showCaption="false" indent="2"} - Model and instance configuration page. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/tjlhhzl_FMIZdzIW2D3B5_image.png" size="50" width="1415" height="637" position="flex-start" darkWidth="1415" darkHeight="637" showCaption="false" indent="2"} # Configure the Model After creating the model and defining a name, you can configure it with static and dynamic attributes and schema to represent your assets or data structures. ## Model Image Select a model and click the** Upload image** icon to choose an image for the model. The image displays in the model tile on the *Models* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/5P2JR-CZSllpsgZHNR6Cm_image.png) ## Static Attributes When you create static attributes, you define default attribute values as placeholders. Later, you change the default values in model instances. For example, you might define `Manufacturer` , `Device Description`, `Model` and `Plant` attributes and change the static attribute values later in instances. Manage the metadata for the model from the *Static Attributes* tab. ### Add Static Attributes If you need to filter existing attributes, you can use the search field. **To add static attributes:** 1. From the *Static Attributes* tab, click **Add new static attribute**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/HrNlIzKeM4oF1JXziCc-n_image.png" size="80" width="1363" height="601" position="flex-start" darkWidth="1363" darkHeight="601" showCaption="false" indent="2"} 2. In the **Attribute Name** field, either select an attribute from the drop-down list or enter a new attribute name. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/uViDBm7SvqvqGMv2jU0Xa_image.png" size="80" width="777" height="517" position="flex-start" darkWidth="777" darkHeight="517" showCaption="false" indent="2"} 3. In the **Attribute Value** field, enter a value for the attribute. ### Import Static Attributes Before importing, create a CSV file with the following headers, then add rows with attribute names and values. **Required Headers** - ModelName - Key - Value **Optional Headers** - InstanceName After creating the file: 1. Navigate to **Static Attributes**, and select **Import Attributes**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0PG0p86BgtsmCCbzunhYp_image.png" size="70" width="909" height="363" position="flex-start" darkWidth="909" darkHeight="363" showCaption="false" indent="2"} 2. In the dialog your browser opens, navigate to and open the CSV file. ### Export Static Attributes You can export all attributes to a CSV file, modify them offline, and import them again. To export a CSV file with existing static attributes: Navigate to **Static Attributes**, and select **Export Attributes**. Attributes export to a CSV file. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/gNt_0_fes1K8ePB5JImje_image.png" size="80" width="905" height="312" position="flex-start" darkWidth="905" darkHeight="312" showCaption="false"} ## Dynamic Attributes Next, define dynamic attributes that represent real-time data for your asset. Dynamic attributes can be JSON, boolean, array, string, or number data types. Each dynamic attribute can have an associated transformation. ### Add Dynamic Attributes **To add a dynamic attribute:** 1. Click the **Add item** icon. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/miho4gYW1T0Uy9nxWIm7j_image.png" size="100" isUploading="false" width="1365" height="470" darkWidth="1365" darkHeight="470" showCaption="false" indent="2"} 2. In the **Name **field, enter a name for the attribute. 3. Optionally, enter a value for **Unit **and select a **Data Type**. JSON applies if you do not specify a data type. 4. The **Skip Key **option is only available when the data type is JSON. Select **Skip Key** to exclude a specific attribute from the payload. Note that the value persists in the payload, for example, as `value='20'`. 5. Optionally, define a topic expression consisting of static string values and parameters by surrounding the expression in curly brackets (`{}`). For example, `devicehub.alias.{device}.tagname`. 6. Optionally, if you've created data transformation schemas, select one from the **SchemaID **field. 7. If you need to filter existing attributes, you can use the search field. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/bpnIJp3AW_EkOCH0gQ4Oz_image.png" size="100" width="934" height="315" position="flex-start" darkWidth="934" darkHeight="315" showCaption="false" indent="2"} ### Import and Export Dynamic Attributes To import dynamic attributes, download the sample CSV file and populate it with your dynamic attributes. After creating the file, click the model tile, navigate to **Dynamic Attributes**, and click the **Import Attributes** icon. To export a CSV file of existing dynamic attributes, click **Export Attributes**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/TNYO0UcV_QISp2Z2kIOH-_image.png" size="80" width="1369" height="359" position="flex-start" darkWidth="1369" darkHeight="359" showCaption="false"} ## Transformations Use transformations to convert the raw JSON data published on topics in the message broker to a desired format. Transformations apply to specific dynamic attributes and the resulting transformation is included in the full Digital Twins and Publish Attributes payloads. Transformations clean your data and make it easier for northbound systems to consume. For example, create a transformation that eliminates duplicate timestamps and register IDs in your payload. Transformations parse and transform the payload and specify a payload structure as the model inherits data. See [Use Digital Twins to Contextualize Data](docId\:VDRP68HIwEA7iyLgo3eW7) for information on formatting transformations. With transformations, you can: - Create a JSON transformation that filters specific key-value pairs . For example, this transformation only includes the following attributes in the payload. :::CodeblockTabs{indent="2"} ```json } “value“: “$value“, “timestamp“: “$timestamp“: } ``` ::: - Create a JSONata transformation to perform dynamic filtering. [JSONata](https://docs.jsonata.org/overview.html) is a query language that allows logical conditions and computed outputs. For example, use JSONata to create an alert when a temperature tag exceeds a high or low threshold value. :::CodeblockTabs{indent="2"} ```json { "asset": deviceName, "area": metadata.area, "line": metadata.line, "quality": success, "metric": "metric", "timestamp": $fromMillis(1510067557121, '[M01]/[D01]/[Y0001] [h#1]:[m01][P]'), "value": value } ``` ::: - Use a playground to test out your transformations before adding them to a model. ### Configure Transformations **To add a transformation schema:** 1. Select the **Transformation **tab and click **Add a Schema**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6lKJuD52nj1CenMVeu0uG_image.png" size="80" width="1416" height="383" position="flex-start" darkWidth="1416" darkHeight="383" showCaption="false" indent="2"} 2. Enter a name for the schema. 3. Select from **JSON **or **JSONata **from *Schema Type* drop-down menu. 4. In the code window, copy and paste the JSON-based or JSONata schema. 5. (Optional) You can use the *System Variables *in the code drawer. 6. Experiment in a playground. 7. Click **Add**. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/H2kgVlG9Be7fgHSNzExg4_image.png" size="80" width="1324" height="787" position="flex-start" darkWidth="1324" darkHeight="787" showCaption="false" indent="2"} 8. To edit or delete a schema, click the **Action menu** for the schema and select an option. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/2mGSZpYeUvxw4Lm_kTakG_image.png" size="80" width="1417" height="573" position="flex-start" darkWidth="1417" darkHeight="573" showCaption="false" indent="2"} 9. Apply the transformation to specific dynamic attributes. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/hmBoKyHjVYyjgVOvi0U0D_image.png" size="40" width="531" height="331" position="flex-start" darkWidth="531" darkHeight="331" showCaption="false" indent="2"} ## Configure Parameters Parameters are variables that you can insert into topic expressions. Parameters help you save time when defining instances that have many attributes. For example, define a `device` parameter and add it as a topic expression for a dynamic variable with the following syntax: `devicehub.alias.{device}.tagname`. Then modify the value for the `device` parameter for each instance on the **Instance Parameters** configuration page. :::hint{type="info"} **Note:** Parameter names and values are case sensitive and cannot contain whitespaces. Allowed characters: - A-Z in lowercase and uppercase - 0-9 - Hyphen (`-`) and underscore (`_`) characters. ::: To create a parameter: 1. Navigate to the **Parameters** tab and click **Add Item**. 2. Enter a parameter name and a placeholder value. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/vz7aOACClOwFX7YSF3_WV_image.png" size="80" width="1716" height="500" position="flex-start" darkWidth="1716" darkHeight="500" showCaption="false" indent="2"} 3. Click **Save Row**. The new parameter saves. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Mb1bOMo5UAyDrd89phXo1_image.png" size="80" width="1715" height="478" position="flex-start" darkWidth="1715" darkHeight="478" showCaption="false" indent="2"} 4. Add the parameter to a topic expression. In this example, `devicehub.alias.{device}.Temperature` is added to the Temperature attribute. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/CJg3VJFUo_we7yju6S1b-_image.png" size="100" width="1713" height="546" position="flex-start" darkWidth="1713" darkHeight="546" showCaption="false" indent="2"} 5. Select an instance of the model and click **Open Parameters**. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/fc5rKU5pvYhvA81LBw4s3_image.png" size="80" width="1512" height="553" position="flex-start" darkWidth="1512" darkHeight="553" showCaption="false" indent="2"} 6. In the **Instance Parameters** dialog, edit the value for the device. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/ciQXOhO6bjFyjKp4x-jSc_image.png" size="80" width="1249" height="744" position="flex-start" darkWidth="1249" darkHeight="744" showCaption="false" indent="2"} 7. Navigate to the **Instance Dynamic Attributes** page to see the topic defined for the dynamic attribute, based on your topic expression and parameter values. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/1nfhKjBSrS16ovkUceek4_image.png" size="80" width="1792" height="302" position="flex-start" darkWidth="1792" darkHeight="302" showCaption="false" indent="2"} :::hint{type="info"} **Note:** If a dynamic attribute has a topic expression defined, the topic for instances cannot be edited. To change the dynamic attribute topic, you must edit the model or parameter values. ::: ## Schema Use the *Schema *tab to create a custom data structure for the model. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/w2jWB0PmYjwlZH_ZnBLuQ_image.png" size="80" width="1418" height="572" position="flex-start" darkWidth="1418" darkHeight="572" showCaption="false"} To create a category for the schema 1. Click the **Action menu** icon for `root` and select **Add Node**. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/bzfhCUhaDuytz8Rx5eeVS_image.png" size="80" width="1418" height="590" position="flex-start" darkWidth="1418" darkHeight="590" showCaption="false" indent="2"} 2. To add attributes to the schema, do one of the following: - Drag and drop attributes from the left-hand list to the canvas under the appropriate category. - Click the **Action menu** for a category and select **Add item to Node**. Then, select the attribute to add. 3. When you have configured the schema, click **Save Model**. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/31uNHcIQd4kUcCSpSCB7b_image.png" size="80" width="1418" height="590" position="flex-start" darkWidth="1418" darkHeight="590" showCaption="false" indent="2"} ### Export Schemas To export an existing schema to a CSV file, click the **Export Schema **icon. ### Sync Attributes To sync the existing schema 1. Click the **Sync Attributes **icon. All attributes are appended to the current hierarchy. If they exist, the *static\_attributes *and *dynamic\_attributes *nodes are recreated. 2. To confirm that you want to proceed, click **Yes**. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/F_Jg9HwHL1ZhWA6OFJpg8_image.png" size="80" width="1418" height="550" position="flex-start" darkWidth="1418" darkHeight="550" showCaption="false" indent="2"} ### Clear Schema To clear the schema builder tree, click **Clear Schema**. Changes apply when you save the model. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/ek_7X8MOUaQz84sUSJODU_image.png" size="80" width="1418" height="550" position="flex-start" darkWidth="1418" darkHeight="550" showCaption="false"} ## Apply Model Updates to Instances When you update your model, you can apply the changes to model instances. To apply model updates: 1. Click **Upgrade Instances**. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/w7qQIdsrHtyK2pXC_-mvW_image.png" size="80" width="1415" height="678" position="flex-start" darkWidth="1415" darkHeight="678" showCaption="false" indent="2"} 2. Select the instances to upgrade and click **Upgrade**. ::Image[]{src="https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/FX9n4ks-5B46lAE4UBYw4_image.png" size="50" width="584" height="311" position="flex-start" darkWidth="584" darkHeight="311" showCaption="false" indent="2"} [title] Manage Digital Twin Models [path] Litmus Edge Manager User UI/Product Features/Digital Twins/ You can add or remove a Digital Twin model, add or remove tags to the model, and arrange the tags in a Schema. You can download a tag Schema JSON. You can enable or disable a Digital Twin model. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/D91jTl43ugZdQm32R9K5i_image.png "Manage Digital Twins") | **Action** | **Details** | | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Import Model from file (**`.json`**)** | Upload a model from a JSON file. | | \[2] **Deploy models to edge device** | Transfer models to the specified edge device. See [Deploy Digital Twin Models to Edge Devices](docId\:hyW_gkgyU2viMnc0I8Nqg) for details. | | \[3] **Upgrade Models** | Upgrade your models deployed on edge devices. | | \[4] **Switch between Table view/Module view** | Toggle between different display formats. | | \[5] **Export Model** | Save the current model to a file. | | \[6] **Clone ** | Create a duplicate of the selected model. | | \[7] **Edit Model** | Modify the properties and settings of the model. | | \[8] **Upgrade to Edge Device** | Upgrade your models deployed on edge devices. | | \[9] **Deploy to Edge Device** | Install the model on an edge device. | | \[10]** Delete** | Remove the selected model from the system. | | \[11] **Action menu** | - **Export Model** - **Clone** - **Edit Model** - **Deploy to Edge Device: **See [Deploy Digital Twin Models to Edge Devices](docId\:hyW_gkgyU2viMnc0I8Nqg) for details. - **Delete** | | \[12] **View Model** | See [Modify a Digital Twin Model](docId:9zfKLpe8q4G8DEIUqz1cB) for details. A Digital Twin Model does not need to be modified with customizations before being deployed. | # Next Steps - [Modify a Digital Twin Model](docId:9zfKLpe8q4G8DEIUqz1cB) - [Deploy Digital Twin Models to Edge Devices](docId\:hyW_gkgyU2viMnc0I8Nqg)**** [title] Add a Draft Application Release [path] Litmus Edge Manager User UI/Product Features/Marketplace: Catalogs and Applications/Application Releases/ You can add a draft release for a Docker application. A release is a new version of a Docker application. # Before You Begin Ensure you have the following: - A marketplace catalog for your application. You may wish to create a new catalog. See the *Add Catalog* option in [Marketplace: Catalogs and Applications](docId\:gqoGt_Szm8rz9UdPhl2NL) for details*.* - An application to create a new release for. You may choose to create a new application for its first application release (See the *Add or Import an application *option in [Marketplace: Catalogs and Applications](docId\:gqoGt_Szm8rz9UdPhl2NL) for details) or create a new application release for an existing application. # Step 1: Create a Draft Application Release **To create a draft application release:** 1. (Optional) Click **Containers Advanced** or **Compose**. By default, the tab is **Containers**. 2. Click the **Add release** button. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/AotKRcbzzybgHcNNx000q_2023-07-2111-02-27.png "Add release button") 3. From the *Add Release* dialog box, enter the following details: - **Release Name**: Enter a release name (unique in the context of the application). A release version number is also recommended for certain applications. - **Description **(Optional): Enter a release description specific to only this release. - **Readme **(Optional): Enter plain text or Markdown content. The readme will provide important details such as what the application can/will do, and how to use the application. 4. Click on the newly created draft application release's tile. (When hovering a tile, it will display **View more details about this release.**) ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/-cFEIaAQnZKqx-srxvVPP_2023-07-2111-05-19.png "Newly created application release tile [2.8-jessie is example]") # Step 2:  (Optional) Add Launch Variables to the Draft Application Release See [Set Up Variables for an Application Release](docId\:HF5YyWh3bwhFi6m2jKxHt) for details. # Step 3: Add a Docker container configuration to the Draft Application Release See [Set Up Docker Container Configurations for an Application Release](docId\:mebpl6tcgzj9NS2Cmk5cQ) for details. # Step 4: Submit the Draft Application Release You will need to go to the Draft Application Release tile, click the **Edit Release** icon, and select **Submit Release**. See [Manage Application Releases](docId\:FoZMtmXkxEI6Y-gPZAEvg) for more details. Once a Draft Application Release has been submitted, you can no longer modify it. You would need to create a new release or clone the submitted release, and then modify the clone (while it is still in the Draft status). # Step 5: Deploy the Submitted Application Release After submitting the Draft Application Release, you can deploy it to multiple Litmus Edge instances. See [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw) for details. [title] Manage Tokens [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/Tokens/ :::hint{type="info"} **Note**: The Tokens feature is available for Litmus Edge Manager 2.7.0 and later. ::: Refer to the following actions you can take from the *Tokens* pane under Litmus Edge Manager Admin Console Settings. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/FN01tInXk9XOHpiYGgnVQ_image.png "Admin Console Tokens") | **Action** | **Details** | | ---------------------------------------- | ----------------------- | | \[1] **Show filter** / **Hide filter**: | Search by *Token Name*. | | \[2] **View details** | Display details | | \[3] **Action Menu** | - Remove - View details | [title] Kafka [path] Litmus Edge Manager Admin Console/Product Features/Integration/ # Kafka Settings The Kafka Settings sub-module under the Integration module provides you with all the tools needed to set up and manage the Kafka configuration. The Kafka Settings sub-module includes the following sections: - **Kafka Server**: Allows you to view and copy the bootstrap server link, view and copy the Kafka SSL connection URL, and download the Kafka certificate. - **Users**: Allows you to add and remove a Kafka user and change the password for a Kafka user. - **ACL**: Allows you to add and remove an access control list (ACL) for a Topic, and copy an ACL user name. # Access Kafka UI 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Integration**. Integration's *Kafka* pane by default appears. Refer to the following actions you can take on Litmus Edge Manager Admin Console's *Kafka* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/cwEq1ciriaoQlpoGsCtN7_kil4ndn4q1qpb1d7ut-haimage.png "Litmus Edge Manager Admin Console: Kafka") :::hint{type="success"} **Tip**: - The URL for the Bootstrap server can be pasted to the Broker field of the* Kafka* consumer in Flows. - Some consumers require a separate IP and port. ::: | **Action** | **Details** | | --------------------------------------------- | --------------------------------- | | \[1] **Copy Kafka bootstrap server link** | port `9092` for non-SSL. | | \[2] **Copy Kafka bootstrap server SSL link** | Port `9093` for SSL.
| | \[3]** Download Kafka CA certificate** | Downloads a `ca_chain.pem` file. | | \[4] **Show filter** /** Hide filter** | Search by *User Name*. | | \[5] **Add New User** | Add a new user name | | \[6] **Action menu** | - Change Password - Remove | | \[7] **Show filter** /** Hide filter** | Search by *User Name* | | \[8] **Add ACL** | Add ACL | | \[9] **Action menu** | * Remove | | \[10] **Copy to clipboard** | Topic | | \[11] **Copy to clipboard** | User Name | [title] Reports [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ You can now send periodic performance statistics of your Edge devices directly via email to offer tailored reports to individual sites or divisions. Metrics show percentage changes based on the report frequency. For example, an Uptime (Online) metric shows the number of hours online and change since the last report. To view daily digest settings, toggle the **Enable Report **toggle. Here is a list of the information you can choose to send in email report: - **Edge Node Metrics:** - **Connected Edge Nodes:** The number of edge devices that are connected. - **Estimated Messages / Second:** An estimate of how many messages are being processed. - **Flows:** The number of data flows. - **Total Applications:** The total number of applications. - **Connected Integrations:** The number of integrations that are connected. - **Disconnected Edge Nodes:** The number of edge devices that are disconnected. - **Newly Connected Edge Nodes (Recently Added Edge Nodes):** The number of edge devices that have recently connected. - **Connected Industrial Systems:** The number of industrial systems that are connected. - **Industrial Disruptions: **Problems with industrial connections. - **Messages sent to Litmus Edge Manager: **The number of messages sent. - **Alerts & Triggers:** - **Number of alerts resolved:** Display how many problems have been fixed. - **Number of triggers generated: **Display how many times certain conditions have been met. - **Litmus Edge Manager Uptime & Downtime: ** - **Uptime (Online): **Display how long Litmus Edge Manager has been running. - **Downtime (Offline): **Display how long Litmus Edge Manager has been stopped. - **Active Users, Companies, and Projects:** - **Total No. of Users: **The total number of users. - **Total No. of Companies: **The total number of companies. - **Total No. of Projects:** The total number of projects. - **New Device Onboarding/Offboarding:** - **Total number of new device onboarding: **Display how many new devices have been added. - **Total number of new device offboarding: **Display how many devices have been removed. - **Applications & Catalogs:** - **Total number of applications deployed: **Display how many applications have been installed. - **Total number of catalogs deployed: **Display how many catalogs have been installed. - **Templates:** - **Total number of templates deployed at instance level:** Templates deployed for the entire system. - **Total number of templates deployed at company level: **Templates deployed for specific companies. - **Total number of templates deployed at project level:** Templates deployed for specific projects. - **License:** - **Change in Node-locked License Activation: **Changes in the activation of specific licenses. - **Change in Site License Activation:** Changes in the activation of licenses for a location. - **AI/ML Models:** - **Total number of models deployed: **Display how many AI models have been installed. - **Software Update:** - **Total number of software updates deployed:** Display how many software updates have been installed. - **CPU, Memory, Network Load, Disk Usage: **Information about how many resources Litmus Edge Manager is using. *Please note:* This information is only for Litmus Edge Manager. - **CPU Utilization:** Display how much the processor is being used (User & System). - **Memory Usage:** Display how much computer memory is being used. - **Network Load:** Display how much data is being sent and received. - **Storage Utilization:** Display how much storage space is being used. - **Edge Node Uptime & Downtime:** - **Uptime (Online):** Display how long the edge devices have been running. - **Downtime (Offline):** Display how long the edge devices have been stopped. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/jeEjxHqUFICFooW2QF_-N_image.png) # Report When *Report* is enabled, do the following: - **Period Frequency: **Choose to receive updates daily, weekly, or monthly. - **Enable All Metrics: **Select specific performance metrics to include in emails. - Click **Save **or **Send Report**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/XhXoPJ2r_KmMNC4QI-9ah_image.png" size="100" isUploading="false" width="1724" height="451" showCaption="false" indent="2"} # Subscription You can manage the list of subscribers for the reports. :::hint{type="info"} **Important Notes: ** - Only users with admin rights can configure the email settings. - Users must set up SMTP [Email](docId\:GcxRXKR3-oc_O9zqz7Jke) settings to enable updates. ::: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/XovyKFdl3HuzMdqB-8jZq_image.png) | **Action** | **Details** | | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Show filter: ** | Filter the list of subscribers. | | \[2] **Add Subscriber: ** | Add a new name and email to subscribe to the reports. | | \[3] **Refresh list: ** | Reload the list of subscribers. | | \[4] **Action: ** | - **Edit Subscriber: **Change the details like name or email for a subscriber. - **Enable Subscriber: **Include or exclude the subscriber in the report. - **Send Report:** Manually send a copy of the report. - **Delete Subscriber: **Remove the subscriber from the list. | [title] Docker Images [path] Litmus Edge Manager Admin Console/Product Features/Docker Registry/ The *Images*** **sub-module allows you to upload images from the network or your hard drive, and pull them from the Docker registry. You can also view details for the image, copy an image pull command, and remove any images stored on the images pane. *Docker Images *includes the *Image List* section where you can manage the Docker images. :::hint{type="info"} **Important: **If the Docker Registry is disabled, you can enable at [Docker Settings](docId\:fNOt3P4u58-kh423wRE8K). ::: # Before you begin Make sure you do the following: - Have permissions for the Docker Registry. - Enable the Docker Registry in [Docker Settings](docId\:fNOt3P4u58-kh423wRE8K). - Enable the Authentication in [Docker Settings](docId\:fNOt3P4u58-kh423wRE8K). You must enable authentication to make sure the login user is registered. If you don't enable authentication, anyone can pull the image from the Docker Registry. # Access Docker Images UI **To access the docker images UI:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Docker Registry**. Docker Registry's *Images* pane by default appears. Refer to the following actions you can take on Litmus Edge Manager Admin Console's *Docker* *Images* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/zGZ7aEOAnk2ulf_FWDcO__hyzzouhpqqwco9ju6vsjaimage-1.png "Litmus Edge Manager Admin Console: Docker Images") | **Action** | **Details** | | --------------------------------------------------------------------- | ------------------------------------------------ | | \[1] **Show filter / Hide filter** | Search for images | | \[2] **Upload Docker image** | Docker image files are in a `.tar` file format. | | \[3] [Pull Image from Docker Registry](docId\:lvtAxUAcy7JXd0QqVM-PE) | Pull the image to local network | | \[4] **Expand Docker Image Details** | The Syslog server will receive the test message. | | \[5] **Click to copy ** | - Pull command | | \[6] **Action menu** | * Remove | [title] Management [path] Litmus Edge Manager Admin Console/Product Features/Data Lifecycle/ The *Management* module allows you to download archived data files and purge the archived data files from this sub-module. The types of archived data files you can download are: - **Events**: Litmus Edge event data. - **Incidents**: Incident history data generated by alerts. - **OMA**: Litmus Edge data in OMA format. This format has been deprecated from Litmus Edge and Litmus Edge Manager. - **Raw**: Litmus Edge data in raw format. When you purge an archive, all the data for the selected project is removed. The Management module includes the Data Archive list. # Access Management UI **To access the management UI:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Data Lifecycle**. Data Lifecycle's *Statistics* pane by default appears. 3. From Data Lifecycle's navigation sub-panel, select **Management**. Data Lifecycle's *Management* pane appears. Refer to the following actions you can take on the *Data Lifecycle* > *Management* pane. The user interface below is for Litmus Edge Manager version 2.10.1 and later. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/JQ65b83_Il73qRAcAcmT6_image.png" size="80" width="1920" height="866" position="center" caption="Data Lifecycle: Access Management" showCaption="true"} | **Action** | **Details** | | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Show filter** / **Hide filter** | Open the filter option. | | \[2] **Refresh ** | Update the list. | | \[3] **Download File** | Files that can be available to download are:
* events * incidents * oma - This format has been deprecated from Litmus Edge and Litmus Edge Manager. * raw | | \[4] **Action ** | - **Purge: **This will delete the archived data from the Litmus Edge Manager. Purging a data archive cannot be undone. | :::hint{type="info"} **Important Notes: ** - The Event data is not automatically deleted after archiving. It remains stored unless manually removed. ::: [title] Litmus IQ [path] Litmus Edge Manager Admin Console/Product Features/Integration/ Litmus IQ is an AI chat agent that accepts questions in natural language based on daily digest report data. For example, use the AI chat agent to ask 'How many edge devices are online' or 'What's the current disk usage and available space'. After configuring Litmus IQ, an AI chat agent becomes available on all Litmus Edge Manager pages. :::hint{type="info"} **Note:** Litmus IQ is an experimental feature and must be enabled in the Admin Console in **Settings** > **Experimental Features**. For more information, see [Experimental Features](docId\:PtIJysv_x6gV1g0Z4oR2B). ::: To configure Litmus IQ: 1. In Litmus Edge Manager Admin Console, navigate to **Integration** > **Litmus IQ**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Lio0PO8VqmPQpEa3pSVs8_image.png" size="100" isUploading="false" width="1462" height="579" darkWidth="1462" darkHeight="579" showCaption="false" indent="2"} 2. In **Base URL**, add the root URL (endpoint) where LEM will send OpenAI-compatible API requests for the chat agent. 3. In **API Key**, add the API key for authenticating requests to the OpenAI-compatible service. 4. In **Chat Model**, specify the AI model to use for chat responses and requests. 5. To enable converting docs and user queries into vectors for semantic search and Retrieval-Augmented Generation (RAG): 1. Select **Embedding support**. 2. In **Embed Model**, specify the model for generating vector embeddings. 6. Click **Validate** to confirm that integration settings are correct. 7. Click **Save**. [title] Interfaces [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/Network/ :::hint{type="info"} **Note**: The Interfaces feature is available for Litmus Edge Manager 2.8.0 and later. ::: You can configure the interface settings and add a static IP address by navigating to **Settings** > **Network** and clicking the **Interfaces** tab. To change the IP address to access Litmus Edge Manager, see [Change the IP Address of Litmus Edge Manager](docId\:qcv7MR9ma_fzEqjKizQpC). This feature enables you to configure Litmus Edge Manager so that it can be accessible from multiple IP addresses. The user interface below is for Litmus Edge Manager version 2.10.1 and later. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/MAl0YKeMKaRD3bvq32per_image.png "Interfaces Tab") # Update Network Interface Adding a new address will enable you to access the Litmus Edge Manager from the new IP address. Contact your local network administrator for accessible IP addresses. You can also enable/disable DHCP for the network interface as needed. :::hint{type="info"} **Note**: As of Litmus Edge Manager version 2.10.1, if DHCP is disabled, you must have at least one IP address with a gateway. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/sCmJOgjeMhoXIwayspn5o_image.png" size="80" width="684" height="431" caption="Update Network Interface" position="center" showCaption="true"} # Next Steps - [Change the IP Address of Litmus Edge Manager](docId\:qcv7MR9ma_fzEqjKizQpC) [title] Step 5: Create an Activation Request in Litmus Edge [path] How-To Guides/Litmus Edge Manager User UI Guides/Apply a Parameterized Template During Activation/ You will need to create the activation request from a new Litmus Edge instance that will be sent to the Litmus Edge Manager. **To create the activation request from the un-activated Litmus Edge instance:** 1. In a new browser, log in to your Litmus Edge instance and navigate to **System** > **Device Management **> **Litmus Edge Manager Activation**. 2. Copy and paste the **Activation URL** from *Step 4* to the *Data & Device Management Endpoint* input field. Then click **Validate **to establish a connection. 3. Copy and paste the **Activation Code** from *Step 4 *to the *Activation Code* input field. Then click **Activate**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Aaoa8UMYTWTTP2cUlqx08_image.png "Litmus Edge Manager Activation pane") 4. The *Activation request has been sent *dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/qM6xoOn2gTyUQlPJd5DDc_image.png" size="70" width="640" height="213" position="center" caption="Activation request has been sent dialog box" showCaption="true"} # Next Step After creating an activation request in LE, you need to [Approve the Activation Request in Litmus Edge Manager.](docId\:CVo0Mhk6WBQBM6fyeVElD) [title] How to Enable 2FA on Keycloak for LEM Authentication [path] How-To Guides/Litmus Edge Manager User UI Guides/ You can enable two-factor authentication through Keycloak to securely authenticate your Litmus Edge Manager (LEM) account. **To enable 2FA on Keycloak:** 1. Log in to *Litmus Edge Manager* and navigate to **Dashboard**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/05YE46Z1C1en2OJ9zmiiI_image.png "LEM Dashboard") 2. Click on your **profile **icon in the upper right corner and select **Profile**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/fDUi9iNCdFCytvMl5AwKV_image.png "LEM Dashboard Profile Icon") 3. The *KEYCLOAK* profile opens in a new b. 4. Click on** Account security **in the left sidebar and select** Signing in** from the drop-down menu. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/RKBDwBAU-RJD9pLcP9Zjv_image.png "KEYCLOAK - Account security page") 5. Click the **Set up Authenticator application** button next to the *Two-factor authentication* section. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3uhCs1A5w-41y6zA28DFM_image.png "KEYCLOAK - Account security - Signing in page") 6. You will be redirected to the *Update password *screen. [title] Step 3: Apply the Variables and Download the Parameterized Template JSON Configuration [path] How-To Guides/Litmus Edge Manager User UI Guides/Apply a Parameterized Template During Activation/ You can apply the variables to the template and download the JSON to verify the variables were correctly applied. **To apply the new variables and download the parameterized template:** 1. From the *Parametrized Template* panel, find the attribute to apply the variable. For this guide, it's the name of two *DeviceHub Devices* and *Country code*. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/eE1sS91nCQqnLKGmKdsCp_image.png "Parametrized Template panel") 2. Click the **Edit variable** button next to an attribute and use the drop-down menu to select the right *variable *for that attribute. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/5sVGpzpGYOlDLWHh4X353_image.png "Parameterized Template panel") 3. Click the **green tick** next to the attribute after selecting the variable. 4. Repeat steps 2-3 for the other two variables and their attributes. 5. Click** Save parameterized** **template**. Then click **Preview Template** to open the* Set Variables* dialog box. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/N56p-dnzPG0eLWUY1SEyu_image.png "Parameterized Template Save and Preview Button") 6. Fill in details for newly added variables in the *Set Variables *dialog box: - Please refer to the list of [country codes for ISO 3166](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) when choosing the appropriate **Country\_Code**. - Please provide a suitable name for both of the devices. - Click **PREVIEW**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Pio9vjGTbACIAErODqjTe_image.png" size="70" width="628" height="676" position="center" caption="Set Variable dialog box" showCaption="true"} 7. The *Preview* *template *dialog box appears. Verify the variables and click **DOWNLOAD**. The template's *JSON *configuration is saved on the computer. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ZtClFO9ozVz01CqEMdBC3_image.png" size="70" width="622" height="676" position="center" caption="Preview template dialog box" showCaption="true"} 8. Open the **JSON **configuration file using Notepad and verify whether the variable names entered in the *Set Variables* dialog box are correctly displayed here. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/J4KCmZl6282RYe8JxFYa6_image.png" size="70" width="678" height="996" position="center" caption="JSON preview for template" showCaption="true"} # Next Step After downloading the JSON, you will [Create a Basic Activation Configuration with a Parameterized Template in Litmus Edge Manager.](docId\:jzPhm4AiKUMCZe9HvzL-a) [title] Set Up Alert Triggers [path] Litmus Edge Manager User UI/Product Features/Alerts/ :::hint{type="info"} **Note**: The user interface below is for Litmus Edge Manager version 2.10.1 and later. ::: You can add an alert trigger for edge devices in the *Triggers* section in the *Alerts* module. Review the following guides for setting up alert triggers: - [Create an Email-Alert Trigger for Connector Online Status](docId\:da-gvxuEPnYfpaTsSYhcq) - [Create an Email-Alert Trigger for DeviceHub Device Data Quality](docId\:keO0ctAMmo949dTzLGw7V) ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/A38eHBYNP-fMkJ2HOT1cn_image.png" size="80" width="1298" height="760" position="center" caption="Add new trigger icon" showCaption="true"} :::hint{type="warning"} **Important**: Triggers require an action for notification implementation. ::: Variables change depending on the **Source** selected. # Before You Begin Add an action to the *Action List* to receive a notification. See [Add new Action](docId\:BWq6oBkuTNZgIJBIgQPBE) for details*.* # Step 1: Select and Set Up Source Completing the *Source *section first avoids issues with the variables for the*** **Subject*** **and *Message*** **fields in the* Trigger*** **section. The source is the type of condition needed to trigger an alert. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/l92yK6RHiNucMJahWZOGn_image.png "New Trigger: Source section") **To select a source**: 1. Select a **Source**. The options are: - **Metrics: **The *Trigger *section's *Subject* and *Message* fields will be hidden and disabled.** ** - **Events: **The *Trigger *section's *Subject* and *Message* fields will be revealed and enabled. 2. Click the **Add** link to add a new rule. The rule table drops down. The rule table is dependent on your source selection. ## Step 1a: Set Up Metrics Source Select a metrics source to set up an alert that triggers based on metrics collected by Litmus Edge Manager, specifically when the value of a variable is a certain desired value or certain set/interval of values. You may create only one metrics rule per alert. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/VAElv5pvijtNGYgxNSgv4_image.png" size="80" width="1905" height="400" position="center" caption="New Trigger : Source section : Metrics Source" showCaption="true"} From the **Select Alert template** drop-down list, select an alert template and enter a value for each of the respective parameters. Refer to the following table for more information on each alert template: | **Metrics Name \| Source** | **Description / Purpose** | **Parameters** | **Trigger Condition (Create an Alert...)** | | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Connector disk buffer \| Integration | Monitor [Integration](docId\:Wpqo1fE02tmx3AsKewQU6) Connector disk buffer, which is used when the connector’s throughput is insufficient to handle all defined tags coming from Edge devices. | - Target Value in MB - Alert Delay in seconds | When the usage of [Integration](docId\:Wpqo1fE02tmx3AsKewQU6) Connector disk buffer is above \_\_Target\_Value\_\_ MB for more than \_\_Alert\_Delay\_\_ seconds.
| | Connector online status \|
Integration | Detect unplanned [Integration](docId\:Wpqo1fE02tmx3AsKewQU6)Connector disconnections. | * Alert Delay in seconds | When the [Integration](docId\:Wpqo1fE02tmx3AsKewQU6)Connector is offline for more than \_\_Alert\_Delay\_\_ seconds. | | DeviceHub (DH) online status \| DeviceHub | Detect unplanned disconnections of DeviceHub (DH) devices. | - Alert Delay in seconds | When the DeviceHub (DH) device is offline for more than \_\_Alert\_Delay\_\_ seconds. | | DeviceHub (DH) device data quality \| DeviceHub | Monitor the rate of low-quality (i.e. error) messages. A high rate of low-quality messages indicate a problem with either the physical device or the device driver. | * Target Value in msgs/minute * Alert Delay in seconds | The rate of low-quality messages for the DH device is above \_\_Target\_Value\_\_ for more than \_\_Alert\_Delay\_\_ seconds. | | Edge Device online status \| Edge Device | Detect unexpected disconnections of edge Devices. | - Alert Delay in seconds | The edge device is offline for more than \_\_Alert\_Delay\_\_ seconds. | | Edge Device license expiration \| Edge Device | Detect when the license of an edge device has expired. | * Target Value in days * Alert Delay in seconds | When the license for an edge device is going to be expired in \_\_Target\_Value\_\_ days for more than \_\_Alert\_Delay\_\_ seconds. | | Edge Device free disk space \| Edge Device | Monitor the available disk space of an edge device. | - Target Value in Percentage - Alert Delay in seconds | When the free disk space is less than \_\_Target\_Value\_\_ percent for more than \_\_Alert\_Delay\_\_ seconds. | | Edge Device memory available \| Edge Device | Monitor the available memory of an edge device | * Target Value in Percentage * Alert Delay in seconds | When the Free RAM is less than \_\_Target\_Value\_\_ percent for more than \_\_Alert\_Delay\_\_ seconds. | | Edge Device CPU Idle \| Edge Device | Monitor the CPU usage of an edge device | - Target Value in Percentage - Alert Delay in seconds | When the CPU idle is less than \_\_Target\_Value\_\_ percent for more than \_\_Alert\_Delay\_\_ seconds. | ## Step 1b: Set Up Events Source Select an events source to set up an alert that triggers when a specific event occurs. :::hint{type="info"} **Note: **The trigger for *Events* in Edge devices will only work if the *Forward Events *toggle is enabled. For more details on events, refer to the [Events](docId\:OnS8mKWpVtKc93cOoRAKm) documentation. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/UWVqMEu_SNpoH0AUqV055_image.png" size="80" width="1908" height="496" position="center" caption="Source section: Events Source" showCaption="true"} **To set up an events source**: 1. From the **Severity** drop-down list, select an option. - All - Info - Warning - Alert 2. From the **Component** drop-down list, select an option. - All - cc - Integrations - mp - Marketplace - dh - Device Hub - auth - Auth - dm - Device Management 3. From the **Event ID **drop-down list, select an option. Options are dependent on the* Component *selected. See [Event ID for User Alert Triggers](docId\:gvKc02F1g_KO9srUqXdYD). 4. (Optional) Click **Show Event Attributes...** For each of the event attributes, enter a value. 5. (Optional) In the** Info** field, enter a value. 6. Repeat with additional new rules by clicking the **Add new rule** button as needed. # Step 2: Set Up Trigger :::hint{type="info"} **Note**: For Litmus Edge Manager version 2.14.0 and later, you can customize the subject and message of the trigger alert with your preferred text in addition to the variables. ::: You can customize the trigger's subject/message contents that will be sent to a recipient. The visibility of the *Subject*** **and *Message*** **fields are dependent on the *Source*** **selection from Step 1. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/-wqg7EtcE99kokzlSsW5H_image.png "Set up Trigger: Metrics version") ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6GfWGzK92sYDZgCGzjU2-_image.png "Set up Trigger: Events version") ## Subject and Message Variables You can select from the following variables in the trigger subject and message: - **$devicename**: The name of the associated edge device . (For example: Litmus Edge (08:00:23:18\:r5:32). - **$name**: The name of the associated connector or DeviceHub device. (For example: PLC\_2) - **$alertDelay**: The alert delay parameter configured for the trigger. - **$value**: The current value associated with the connector or DeviceHub device that is being monitored. (For example: connector disk buffer of 98MB) - **$company**: The company associated with the edge device for the trigger. - **$deviceid**: The associated edge device ID. (For example: 9udklweoidslsdd0lksdjfslkd) - **$project**: The project associated with the edge device for the trigger. - **$targetValue**: The target value configured for the trigger. (For example: 50MB for Connector disk buffer) - **$componentid**: The associated component for the event trigger: cc - Integrations, mp - Marketplace, dh - Device Hub, or auth - Auth. - **$message**: The associated event message for the trigger. - **$triggerid**: The associated trigger ID. - **$hostname**: The associated host name for the trigger. - **$tags**: The associated tags for the trigger. - **$severity**: The severity level selected for the trigger: Info, Warning, or Alert. - **$triggername**: The name configured for the trigger. - **$type**: The associated event type for the trigger. - **$eventid**: The event ID associated with the trigger. **To set up the trigger**: 1. In the** Name** field, enter a name for the trigger. 2. (Optional) Click the **Active **checkbox to set an active trigger flag. 3. (Optional) Click the **Dashboard **check box to show trigger alerts on the dashboard. 4. In the **Description** field, enter a description for the trigger. 5. In the **Subject **field, select one or more variables. For Litmus Edge Manager version 2.14.0 and later, you can enter your preferred text in addition to selected variables. 6. In the **Message **field, select one or more variables. For Litmus Edge Manager version 2.14.0 and later, you can enter your preferred text in addition to selected variables. # Step 3: Set Up Scope You can customize the scope of the user triggers. This will determine the applicable edge device(s) that will receive this alert trigger. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/TlZN2XYt9OyMQdwoeyVu0_image.png "New Trigger: Set up Scope") To set up the scope, select an option from the *Scope *section. - **All edge devices** - **Edge Device**. From the **Edge Device** drop-down list, select an edge device. # Step 4: Set Up Action You must create an action to use this section. You can select the response action that will immediately occur after the alert is triggered. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/HlNTd3OwtjixPUqHfnivs_image.png "New Trigger: Set up Action") **To set up the action**: 1. Select an option from the **Action List** drop-down list. 2. (Optional) Select the **Continuously **check box. - If you have checked **Continuously**, enter a value in the **Notification Period** field in minutes. 3. Click **Save**. The alert trigger appears in the Trigger List. :::hint{type="info"} **Important: **To continue receiving incident notifications for the same condition, you must resolve the current incident first. After clicking *Resolve Incident*, a notification will be sent confirming the resolution. ::: [title] Add Tokens [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/Tokens/ :::hint{type="info"} **Note**: The Tokens feature is available for Litmus Edge Manager 2.7.0 and later. ::: You can create a token from the **Settings** > **Tokens** pane. :::hint{type="warning"} **Important**: After a token has been created, it can be viewed but no longer be modified. ::: # Step 1: Create Token **To create a new token:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. Navigate to **Settings** > **Tokens**. 3. Click the **Add New Token **icon. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/71ytbOjjJlYv0guEwpJRv_2023-07-2409-23-19.png "Add New Token icon") # Step 2: Enter Token Details Enter the token name and select the expiration date for the token. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/pa-R87LTpczQHcTrop_GE_image.png "Token Details") # Step 3: Define Token Scope You will need to define what companies and projects the token can access. Make one of the following selections. ## Administrator Scope Selecting this will give the token instance administrator permissions, therefore giving access to all companies and projects. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/G5TMJFg6LRwYFKtc-UUe2_image.png "Administrator scope option") ## All Companies Selecting this will give the token access to all companies and projects, but not instance administrator permissions. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/eMxRCbPHKaRtGHsiAIiYn_image.png "All Companies scope option") ## Custom Token Scope Select individual companies to give the token access to all the projects for the company or select individual projects to the token access to. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/tp5bH0ciQmvKlFEACdOQA_image.png "Custom Token scope access") # Step 4: Edge API Bridge Option :::hint{type="info"} **Note**: This option is available for Litmus Edge Manager version 2.15.0 and later. ::: Select this option to integrate all applicable Litmus Edge APIs through a single Litmus Edge Manager endpoint. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/GVZIwLSP-EeI7fx9zQ5hv_image.png "Edge API Bridge option") The token has access to Litmus Edge APIs through: https\://\[LEM URL]/api/v1/edge/\{project-id}/\{edge-device-id}/\/\* Do the following to retrieve these parameters: - **project-id**: In the Litmus Edge Manager User UI, navigate to **Edge Devices** and click the device name you want to give access to. In the browser address bar, copy the string after the company name. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ORsdGNhM-fidICZ3AhHoX_image.png "Project ID parameter") - edge-device-id: In the same browser address bar, copy the string after **device**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/qSK1PdKp4g6btu7mHlYoh_image.png "Edge Device ID parameter") # Step 5: Save Token After saving the token, make sure to copy it before closing the dialog. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Czs2UE5zudsaPyKuPGg-r_new-token-created.png" size="60" width="552" height="299" position="center" caption="New token created [blurred token]" showCaption="true"} # Use Token When accessing the API, you must use the custom field `X-AuthToken` in the HTTP header. For example: `X-AuthToken: zZA82pIo70xzsrwmSl1f0P6DSfvuZgo1` [title] Admin Console Backup [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ :::hint{type="info"} **Note**: This is available for Litmus Edge Manager version 2.15.0 and later. ::: The *Backup *module allows you to download, upload, and bulk delete Litmus Edge Manager (LEM) application and configuration files. ## Overview The backup process for LEM consists of a compressed and encrypted file downloaded from the LEM Admin UI. The data is updated every 24 hours, and 7 copies of each LEM version are maintained on the server until user deletes them manually. **Backup Type:** Compressed and encrypted file, available for download from the LEM Admin UI. **Rotation:** 7 copies of each LEM version. **Retention Period:** Backup files will remain until user deletes them manually. LEM backup contain the following files: ** 1. Application Data** - Company and project settings - Activation requests - Sites (except site icons) - Triggers and Actions - Templates - Marketplace Applications and their associated data and configurations - Marketplace Catalog (data and configuration) - Grafana Dashboards and other settings - Remote access setup - Licenses (Note: Licenses won't work after restoring on another VM) - Keycloak - Registry Credentials - Certificates - SMTP Settings - Tokens **2. User Data** - Users and their access to specific projects/companies. **3. Marketplace Apps** - All marketplace apps and associated data and configurations. **4. LE Connected to LEM** - All Litmus Edge devices connected to the Litmus Edge Manager. **5. Database Dumps:** - mysql-grafana.sql - mysql-keycloak.sql - mysql-lem.sql - mysql-mpcs.sql - mysql-mpcs\_rbac.sql - mysql-mysql-user.sql ## What Is Not Backed Up - Old upgrades and backups - Events - Docker registry data - ClickHouse data - DNS Entries (LEM only lists DNS servers; not backed up to avoid network access issues) - Network settings ## Process The following process define the steps required to create and upload a backup file in LEM. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/XHYfo8jvqAhjzhQbmfidP_image.png "Backup UI") :::hint{type="warning"} **Important**: - Importing a configuration replaces configuration data and cannot be undone. Select the appropriate bundled zip file. - Any node-locked licenses will be removed after restoring a backup on a new virtual machine (VM). You will have to request new node-locked licenses from your Litmus account representative. - Network files are not backed up to avoid breaks on restore. - As of Litmus Edge Manager 2.24.0 release, LEM Admin UI allows you to create long-term API tokens with scope `LEM Backup`. ::: | **Action** | **Details** | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | \[1] **Create backup** | Download a backup file of the Litmus Edge Manager configuration. Configuration files are password protected and generated as a `.tar` file. Process logs are visible in the *Log* section.
To export the configuration, you'll need the password of the Litmus Edge Manager instance. | | \[2] **Upload backup file** | Upload a Litmus Edge Manager configuration file. To import the configuration, you'll need the password of the Litmus Edge Manager instance. | | \[3] **Remove selected backups** | This option allows you to bulk delete the selected backup configurations files at once. | | \[4] **Show backup/restore log** | View the latest export/Import operation log. You can toggle **Auto-scroll** to the **On **position to automatically scroll down to the most recent messages in *Process Log*. Doing so helps monitor a running export/import process. | | \[5] **Refresh** | Reload the list of backup files. | [title] Edit a User Profile [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/Users/ To edit a user profile, open the action menu for a user and select **Edit User**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/j_CQOf9WRhroUJRuMXTO4_image.png "User action menu") # Edit User Profile You can edit the following sections for the user: - **Edit User**: Change the First Name, Last Name and Email address for the user. You can lock the user account from this section. You cannot change the User Name. - **Change Password**: Change the user password. - **Company Level Teams***:* Add, modify, and remove company teams. You can add or remove team members by clicking on an existing team name. You can filter the company teams list. - **Project Level Teams**: Add, modify, and remove project teams. You can add or remove team members by clicking on an existing team name. You can filter the project teams list. - **Marketplace Roles**: Select or deselect marketplace roles for the user. - **Grafana Roles**: Select or deselect Grafana roles for the user. # Edit Company Team To [Edit a Company Team](docId\:LDllqh5dtQNonPSuQynkX), you can open the highlighted action menu below or click the link for the company name. You can also remove the company team from the action menu. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1owD4bT__4rZDnZb0PgF0_2023-08-1815-58-01.png "Company team action menu") # Edit Asset Management Roles Visibility of edge devices is limited to the companies that a user has access to. Additionally, you specify one of the following roles: - The **Viewer** role provides view access to Digital Twins. - The **Administrator** role provides full access to Digital Twins. # Edit Grafana Roles When the **Grafana administrator toggle **is enabled, the user will receive the `Admin` role for the Grafana Dashboard. When disabled, the user will lose the `Admin` role and be set as an `Editor` or `Viewer`. See [Grafana Dashboards](docId\:YTC1N5pOOjR1elW34jQmF) and [Visualize Child Device Data Using Grafana](docId\:cY2MwkiuvJ2nvNBZhaotC) for details. [title] License Server Management [path] Litmus Edge Manager Admin Console/Product Features/ Litmus uses an integrated license server to manage site-based licenses for Litmus Edge and Litmus Edge Manager. This system enables efficient activation and monitoring of your instances across different sites. After obtaining a valid site license key from the [Customer Portal](https://portal.litmus.io), a corresponding site license is generated and added to the embedded license server. This site license is automatically applied when activating an edge device through Litmus Edge Manager. See [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) for further details. The License Server Management pane includes the following sections. - **Core License List**: Displays all activated site licenses and their statuses for connected edge devices. - **Feature License List**: Displays a list of features enabled with the activated site license. - **Offline Activation**: Enables you to activate a site license key with the license portal and add the respective site license. **To access the license server management UI:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **License Server Management**. The *License Server Management* pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/j25qT5y67VvQXzEaho0nc_image.png) # License Server :::hint{type="info"} **Note**: For Litmus Edge Manager version 2.12.0 and later, the user interface is split into two tabs: *License Server* and *License Clients*. ::: You can view and manage the following sections in the *License Server* tab. ## Core License List The Core License list includes the following information. - **Status**: The current operational status of the site license. - **License Name**: Identifier for the license feature enabled for your edge devices. - **Expiry Date:** The date on which the license will expire. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/JPka0fwuvvGITugBzjsaG_elw6agkdm2zhamw3zge8oimage.png "License Server Management: Core License") | **Action** | **Details** | | -------------------------------------- | --------------------------------------- | | \[1] **Show filter** / **Hide filter** | Search by *License Name*, *Expiry Date* | | \[2] **Action menu** | - Remove | ## Feature License List This list includes the features enabled under the activated site license: - **Status**: The status for each site-license feature - **License Name**: The name of license features included for your connected edge devices - **In use**: The number of iterations that are currently in use for your license features - **Available**: The number of iterations that are available for your license features - **Total Count**: The total number of iterations that are available for your license features - **Expiry Date**: The expiration date for the license feature This section lists available features with the activated site license for edge devices. The License SKU determines the available site-license features and may include: - Analytics - Backup - Core - Catalog - Devices - Marketplace - License Core - OPCUA - Tags - Updates Use the **Show filter / Hide filter **button to search by *License Name*, *Total Count*, or Expiry Date. The action menu also provides an option to remove a license when necessary. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/dk8_JOeVrhj10UPD5rJ9X_izahaqiojsu3kn6aqv9kimage.png "Feature license list") ## Offline Activation :::hint{type="info"} **Note**: This version of Offline Activation is available for Litmus Edge Manager version 2.8.0 and later. ::: - You can add a *Core* or an *Add-on* license for edge devices from the *Offline Activation* section in the *License Server Management* pane. - Once the licenses are added, edge devices that have been or will be activated with a Site license will receive the *Core* and all the *Add-on* Site licenses. - While multiple Add-on licenses can be added as needed, only one Core license can exist. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/vZpwCyX_tl_EB-vNYiZN0_image.png" size="80" width="1819" height="432" position="center" caption="License Server Management: Offline Activation Step 1" showCaption="true"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/AzFwIVaZffCZPyyKEkBWx_image.png" size="80" width="1830" height="240" position="center" caption="License Server Management: Offline Activation Step 2" showCaption="true"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1H4JhGRbgV3HaM1JYlWyd_image.png" size="80" width="1824" height="307" position="center" caption="License Server Management: Offline Activation Step 3" showCaption="true"} ### Before You Begin Ensure you have a site license key, which you can request from the [Customer Portal](https://support.litmus.io). ### Add a Site License Offline **To add a site-based license offline:** 1. From the *Create Activation Request* section: - In the *License Key* field, enter the **Site-License Key**. - (Optional) Select a *License Type *to add from the drop-down menu. - Click **Generate request**. The activation request appears in the *Activation request* field. - Next to the* Activation request* field, Click the **Copy Activation Request** icon. The activation request is copied to your clipboard. - Click **Next**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/zX98ITY44NhM5mDkAT79Z_image.png) 2. From the *Make license file *section, click the **License Portal **link. The Licensing Portal page ([https://litmus.activate.id/offline](https://litmus.activate.id/offline)) opens in a new tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Ut3JjMU_p-wYHSE2eregb_image.png) - Paste the activation request in the *Activation Request* field, and then click **Make License**. (You may need to verify **I'm not a robot**) The encoded license appears in the *Activation Result* field. - Next to the *Activation Result *field, click the **Copy content to clipboard **icon. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/lspIC-DrZ7SnVY1lGigo1_image.png) - Return to the *Make license file* section in the *Offline Activation* browser tab and click **Next**. 3. From the *Add License *section, in the **License **field, paste the encoded license, and then click **Add License**. The *License *is added. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/kQeZjKf8mg8S4gRNnTg2D_image.png) 4. Once a site license is activated, the user must choose the license type; otherwise, the site license will not be applied. This selection can be made in **Settings** > **License **> **License Settings**. # License Allocation :::hint{type="info"} **Note**: For Litmus Edge Manager version 2.26.0 and later, the user interface is split into three tabs: *License Server, License Allocation,* and *License Clients*. ::: You can now allocate data points at the company/project level within a site license. This lets you control and manage data usage across multiple sites or divisions. It's important to note that this feature is only available for site licenses, so the associated edge device allocation is done per site license. **To access the license allocation UI:** 1. From the Navigation panel, select **License Allocation**. The *License Allocation *pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CN7B62h1T0BZ36sNM7ZuS_image.png) | **Action** | **Details** | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Show filter** / **Hide filter** | Search for Licenses to allocate in the table. | | \[2] **Add allocation** | Add or edit a license allocation. To configure:
* Select the company and project for the license allocation. * Enter the number of data points to allocate. * Select the expiry date for the allocation. | | \[3] **Export allocations (CSV)** | Download the list of licenses allocated in CSV format. | | \[4] **Refresh list** | Update the display for the license allocated in the list table. | | \[5] **Action** | Select the following options:
* **Add allocation: **Add or edit a license allocation. * **Delete allocation: **Remove the allocated license. | # License Clients :::hint{type="info"} **Note**: For Litmus Edge Manager version 2.12.0 and later, the user interface is split into two tabs: *License Server* and *License Clients*. ::: You can create and manage edge devices connected to the license server from the *License Clients* tab. The *License Clients* tab allows you to manage the list of Litmus Edge instances that are clients to the license server. You can also add license clients directly without first activating through Litmus Edge Manager and connecting it through a proxy. **To create an activation request for a device on the license server:** 1. From the License Clients tab, click the **Add **icon. The* Create New Request* dialog box displays. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/fnU1kmRrAsLpPhTE2pwTJ_add-icon-for-license-server-device.png" size="80" width="1300" height="627" position="center" caption="The Add icon for a license server device" showCaption="true"} 2. Configure the details for the request. - **Label**: Enter a label to identify the activated device. - **URL**: Review and confirm the license server URL. Update the port value as needed. 3. Click **Create**. The *New Request Created* dialog box displays. 4. Click the **Copy **icon for the activation request. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/wTWQveJSHe8XHg_qzztfi_new-request-created-dialog-box.png" size="60" width="511" height="307" position="center" caption="New Request Created dialog box" showCaption="true"} 5. Log in to the Litmus Edge instance you want to activate and navigate to **System **> **License**. 6. In the *License Server Settings* section, click **Set Server**. The *Set License Server Configuration* dialog box displays. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ED-uo1C0vsanHq_6e5LfQ_set-server-button.png" size="80" width="1156" height="507" position="center" caption="Set Server button" showCaption="true"} 7. In the **Configuration **field, paste the request you copied earlier and click **Save**. If the activation is successful, a success message is displayed. Click the **Action** menu to remove an activated device from the list and select **Revoke activation**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Xtfra17sjjUCzkIRRsz0s_image.png" size="80" width="1480" height="655" position="center" caption="Action menu for an activation request for a license server device" showCaption="true"} [title] NTP [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/Network/ :::hint{type="info"} **Note**: The Interfaces feature is available for Litmus Edge Manager 2.8.0 and later. ::: You can configure the NTP settings by navigating to **Settings** **>** **Network** and clicking the **NTP** tab. This feature is best in used in situations where Litmus Edge instances do not have internet access (thus no access to public time servers). # NTP Clients and NTP Servers Overview In setups where Litmus Edge instances normally have internet, Litmus Edge instances are NTP Clients to an NTP server (available on the public internet) that provide them clock synchronization services. Litmus Edge Manager can instead act as a replacement NTP server to provide clock synchronization services to connected Litmus Edge instances. These Litmus Edge instances will be NTP Clients to the Litmus Edge Manager. In this configuration, Litmus Edge Manager will use its local time to provide the clock synchronization to the Litmus Edge. For Litmus Edge instances to set the Litmus Edge Manager as an NTP Server, see the *NTP Servers* section of [Configure DNS/NTP Servers](docId\:pz9D0WPBQbUGyh0MH6wyx). There is also a more advanced configuration that provides clock synchronization from an existing NTP server. The Litmus Edge Manager can connect to an upstream NTP server (which may be available on the public internet or elsewhere) and receive a time that will be sent downstream to its connected Litmus Edge instances. In this configuration, the Litmus Edge Manager will simultaneously act as an intermediate NTP server to Litmus Edge instance and also an NTP client to the upstream NTP server. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CwdYReYgtgsYmtP0HI--H_image.png" size="80" width="1920" height="866" position="center" caption="NTP Tab" showCaption="true"} | **Action** | **Details** | | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Toggle NTP Server** | Enable the NTP server button | | \[2] **Show Clients** | This feature is only available when the NTP server is enabled. | | \[3] **Refresh NTP Client Status** | This will show the NTP server the Litmus Edge Manager is connected to. If no NTP servers are available, the Litmus Edge Manager will display a status of `LOCAL`, indicating that it will synchronize the time of Litmus Edge instances based on the Litmus Edge Manager's local time rather than a time received from an NTP server. | | \[4] **Enter NTP server address** | You cannot add an NTP Server that's already been added. | | \[5] **Add** | Specify the external NTP Servers that the Litmus Edge Manager will connect to. The Litmus Edge Manager itself will act as an NTP client to these servers. | | \[6] **Delete NTP Server** | Remove NTP server | # NTP Clients When you click **Show Clients**, the **NTP Clients** dialog box opens. It shows the IP address of all Litmus Edge devices connected to the Litmus Edge Manager. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/uqBAnCVc2ytgV9Oy08MRj_image.png" size="80" width="689" height="394" caption="NTP Clients" position="center" showCaption="true"} [title] Step 6: Approve the Activation Request in Litmus Edge Manager [path] How-To Guides/Litmus Edge Manager User UI Guides/Apply a Parameterized Template During Activation/ Once the activation request is sent to Litmus Edge Manager, you will need to approve it. **To approve the provisioning request for an edge device:** 1. From the *Navigation *panel, select **Activation**. The *Configuration* and *Requests* sub-modules drop down. 2. From the navigation panel, select **Requests**. The *Activation Request List* pane appears. 3. Click the **Action** menu after finding your edge device, then select **Approve**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/jCDlQqjFIFUiDrGslSxyd_image.png "Activation Request List pane") # Next Step Once the activation request is approved, you can [Set Variables in Litmus Edge Manager.](docId\:Lqj2utpw90k8Ul3gsZCUU) [title] Step 4: Create a Basic Activation Configuration with Parameterized Template in Litmus Edge Manager [path] How-To Guides/Litmus Edge Manager User UI Guides/Apply a Parameterized Template During Activation/ To apply the Parameterized Template during activation, you need to create a basic activation configuration in LEM. **To create a basic activation configuration with Parameterized Template:** 1. Navigate to **Activation **>** Configuration** and click **Add activation config** icon. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3zZr15TXf_W48zoXDlREm_image.png "Activation > Configuration page") 2. Start configuring the *Limits*, *Licenses*, and *License Type.* See *Steps 1-2 *of [Set Up an Activation Configuration](docId\:VbRFW-a0LLtuJmwdpuNNV) to learn more. 3. To add a template, go to the *Templates *pane and click the **Add template **(**+**) icon. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/v9IikTITZrDeJINgclgvH_image.png "Activation > Configuration > Templates pane") 4. The *Template Select *dialog box appears. Tick the **checkbox** for parameterized template and click **SELECT**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/PEomYlflbY4jWHnQxXASJ_image.png "Template Select dialog box") 5. When done configuring the *Activation Configuration*, click **Save**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/tv2HBbamCUBKia1ktjFgt_image.png "Activation Configuration save button") 6. Once saved, the activation code will then be generated in the *Activation Code* field. This code and the *Activation URL* will be needed when activating a Litmus Edge instance. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Zwx0LrKw_GOt-lmLmxPBp_image.png "Activation Configuration page") # Next Step After creating an activation configuration in LEM, you will [Create an Activation Request in Litmus Edge.](docId\:gwn-33G0VPJYSyIxoTfqj) [title] Create an Email-Alert Trigger for Connector Online Status [path] How-To Guides/Litmus Edge Manager User UI Guides/Alerts Guides/ In this guide, you'll set up an alert and a trigger for Litmus Edge's default MQTT SSL connector that connects to Litmus Edge Manager. Then you will simulate a disconnection for the connector to trigger the alert. # Video :::Iframe{iframeHeight="0" code=""} ::: # Before You Begin - You will have to enable SMTP from the Litmus Edge Manager Admin Console. See [Email](docId\:GcxRXKR3-oc_O9zqz7Jke) to learn more. - If you haven't yet connected your Litmus Edge instance to Litmus Edge Manager, see [Activate an Edge Device](docId\:JalA8oA1dTK8BdVoENAwA). A Litmus Edge instance needs to be activated in Litmus Edge Manager before it can trigger alerts. # Step 1: Set Up an Email-Alert based Trigger In this step you'll create an email notification alert. Next, you will create a trigger that will use the email notification alert. See [Alerts](docId\:BWq6oBkuTNZgIJBIgQPBE) for additional details. From Litmus Edge Manager, navigate to **Alerts** and follow the steps below. ## Step 1a: Set Up an Email Alert **To set up an email alert: ** 1. From the *Alerts *pane, click the **Add new Action** icon. The *Add new Action* dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/jcIeQ5n7Ahq0K5lkrL8Pq_add-new-action-icon.png" size="80" width="1378" height="719" caption="Add new Action icon" position="center" showCaption="true"} 2. From the *Add new Action* dialog box, enter the following details: - **Action Template**: Select EMAIL. - **Action Name**: Enter an action name. - **Enter email**: Enter an email address that will receive the alert. - **Notifications Limit**: Enter 1. - **Interval**: Select *minute*. 3. Click **Add**. The newly created action appears in the *Action List*. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/12fxB2Jd2r2gu7ixNdevB_image.png" size="80" width="1554" height="496" caption="Creating a new email alert" position="center" showCaption="true"} ## Step 1b: Set Up a Trigger **To set up a trigger: ** 1. From the *Alerts *pane, click the **Add new Trigger **icon. The *New Trigger* pane appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/SjncOzK9ps2UhX6kmCCP2_add-new-trigger.png" size="80" width="1379" height="715" caption="Add new Trigger icon" position="center" showCaption="true"} 2. From the *New Trigger* pane, configure the following sections. ### Trigger - **Name**: Enter a name for the trigger. - **Active**: Select the checkbox. - **Dashboard**: Select the checkbox. - **Description**: Enter a description for the trigger. ### Scope Select** Edge Device **and select the appropriate Litmus Edge instance. ### Source - Select** Metrics **as the source of the trigger. - Click **Add **new rule. - **Select Alert template**: Select *Connector online status.* - Enter the value `60` for *Alert Delay, seconds*. ### Action - **Action List**: Select the action you previously created. - **Continuously**: Select the checkbox to send notifications continuously. - **Notification Period, minutes**: Enter 1. When done, click **Save**. The alert trigger appears in the Trigger List. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/JCNGn8a0etxST8x6e1_mc_2023-09-1510-24-18.png "Creating a connection status email trigger") # Step 2: Simulate a Disconnection From Litmus Edge, you will simulate a disconnection with Litmus Edge Manager. **To simulate a disconnection:** 1. Log in to Litmus Edge. 2. From the Navigation panel, select **Integration**. The *Integration *pane appears. 3. From the *generic-mqtt-ssl* tile, click the toggle to disable the connector. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/GJwu3br78QDUWZSXugQl8_image.png" size="80" width="844" height="495" position="center" caption="Disabling the SSL connector" showCaption="true"} # Step 3: Verify Successful Trigger and Alert From Litmus Edge Manager, you will verify the simulated disconnection. **To verify the trigger and alert:** 1. Log in to Litmus Edge Manager. 2. Select the appropriate company and project. The *Dashboard *pane appears for the project. 3. From the navigation panel, select **Incidents**. The *Incidents *pane appears. Confirm you see the incident listed. The email address that was configured for the alert will also receive the respective alert email. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3dnC_ZEFnxsoPoMlqhJRG_vqxt10uwvt7wlaldr8pekimage.png "Alert email") [title] Create an Email-Alert Trigger for DeviceHub Device Data Quality [path] How-To Guides/Litmus Edge Manager User UI Guides/Alerts Guides/ In this guide, you will set up an alert and a trigger for a Litmus Edge device that is generating invalid/corrupted data. Then you will simulate an error output so that an alert is triggered. When the alert is triggered, the email addresses specified in the trigger will receive an email with information about the alert. # Video :::Iframe{iframeHeight="0" code=""} ::: # Before You Begin - You will have to enable SMTP from the Litmus Edge Manager Admin Console. See [Email](docId\:GcxRXKR3-oc_O9zqz7Jke) to learn more. - If you haven't yet connected your Litmus Edge instance to Litmus Edge Manager, see [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB). # Step 1: Add Device Follow the steps to [Connect a Device](docId:3eyAfPpweuVmBLCEy17sq). Select the Device Type **Simulator **and Driver Name **Generator**. # Step 2: Add Tag After connecting the device, you can [Add a Tag](docId:8sE7z3PmRfwL1nmzcwaLX) to the device. Configure the following for the tag: - **Name: **S - Random value generator - **Value Type**: string # Step 3: Import Topic into Default Generic MQTT SSL Connector You will next import the tag you've created as a topic into the generic MQTT SSL connector that connects Litmus Edge to Litmus Edge Manager. **To import the tag into the generic MQTT SSL connector:** 1. Log in to Litmus Edge. 2. Navigate to **Integration**. 3. Click the *generic-mqtt-ssl* connector tile. 4. Click the **Topics **tab. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/RiGXq8U4ibEwXlMqu4VdZ_topics-tab.png" size="70" width="539" height="516" position="center" showCaption="false"} 5. Click the **Import from DeviceHub** tags icon. The *DeviceHub Import* dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/88SwMXPJ-ZlRMlYGiiEL0_import-tags-icon.png" size="80" width="1053" height="483" caption="Import from DeviceHub tags icon" position="center" showCaption="true"} 6. Select the check box to import the tag from the device you created earlier and click **Import**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/6KAn2U3ny1gcM2d__EtNi_devicehub-import.png" size="80" width="962" height="272" caption="DeviceHub Import dialog box" position="center" showCaption="true"} 7. Click the **Enable all topics** icon. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/OFsKCxfI-FgSrUhp1ORi9_enable-all-topics-icon.png" size="80" width="1164" height="469" caption="Enable all topics icon" position="center" showCaption="true"} 8. Return to the *Integration *pane and toggle the connect option and confirm the status is `CONNECTED`. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/I2Ops086U4tzxrunFVNlN_connection-toggle.png" size="60" width="367" height="258" caption="Connector connection toggle" position="center" showCaption="true"} # Step 4: Set Up an Email-Alert Trigger In this step you will create an email notification alert. Next, you will create a trigger that will use the email notification alert. See [Alerts](docId\:BWq6oBkuTNZgIJBIgQPBE) for additional details. From Litmus Edge Manager, navigate to **Alerts **and follow the steps below. ## Step 4a: Set Up an Email Alert **To set up an email alert: ** 1. From the *Alerts *pane, click the **Add new Action** icon. The *Add new Action* dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/jcIeQ5n7Ahq0K5lkrL8Pq_add-new-action-icon.png" size="80" width="1378" height="719" caption="Add new Action icon" position="center" showCaption="true"} 2. From the *Add new Action* dialog box, enter the following details: - **Action Template**: Select EMAIL. - **Action Name**: Enter an action name. - **Enter email**: Enter an email address that will receive the alert. - **Notifications Limit**: Enter 1. - **Interval**: Select *minute*. 3. Click **Add**. The newly created action appears in the *Action List*. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/12fxB2Jd2r2gu7ixNdevB_image.png" size="80" width="1554" height="496" caption="Creating a new email alert" position="center" showCaption="true"} ## Step 4b: Set Up a Trigger **To set up a trigger: ** 1. From the *Alerts *pane, click the **Add new Trigger **icon. The *New Trigger* pane appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/SjncOzK9ps2UhX6kmCCP2_add-new-trigger.png" size="80" width="1379" height="715" caption="Add new Trigger icon" position="center" showCaption="true"} 2. From the *New Trigger* pane, configure the following sections. ### Trigger - **Name**: Enter a name for the trigger. - **Active**: Select the checkbox. - **Dashboard**: Select the checkbox. - **Description**: Enter a description for the trigger. ### Scope Select** Edge Device **and select the appropriate Litmus Edge instance. ### Source - Select** Metrics **as the source of the trigger. - Click **Add **new rule. - **Select Alert template**: Select *DH device data quality.* - For *Target Value, msgs/minute,* enter 1 minute. - For *Alert Delay, seconds, *enter 60 seconds. ### Action - **Action List**: Select the action you previously created. - **Continuously**: Select the checkbox to send notifications continuously. - **Notification Period, minutes**: Enter 1. When done, click **Save**. The alert trigger appears in the *Trigger List*. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/DsjHfYW9CXo-YB4vDxZNZ_image.png" size="80" width="1920" height="866" caption="Creating a new trigger" position="center" showCaption="true"} # Step 5: Simulate Invalid/Corrupted Data From Litmus Edge, you will simulate the DeviceHub driver sending invalid/corrupted data. **To simulate a disconnection:** 1. Log in to Litmus Edge. 2. ~~From the navigation panel, navigate to **DeviceHub **> **Tags**. ~~ ~~ The *Tags* pane appears.~~ 3. ~~Click the **Action menu** for the tag you created and select **Edit**. ~~ ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0e0EVH-1xV-mcr9fWDDtS_edit-tag.png "The Edit option for the tag") 4. For the **Value Type** field, select float64. 5. For the **Formula** field, corrupt the *Formula* field by replacing the `s` in `sin` with `1` so that the final formula starts with `1in`. Then, click **Update Tag**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/SbKcMpkwo-Ei3WUF_VYVP_image.png" size="80" width="1176" height="705" caption="Corrupted Tag Formula" position="center" showCaption="true"} # Step 6: Verify Successful Trigger and Alert From Litmus Edge Manager, you will verify the simulated error rate. **To verify the successful trigger and alert:** 1. Log in to Litmus Edge Manager. 2. Select the appropriate company and project. The *Dashboard *pane appears for the project. 3. From the navigation panel, select **Incidents**. The *Incidents *pane appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/rRs-rERLJhCfGdyFSIZ9e_image.png" size="80" width="1920" height="866" caption="List of incidents" position="center" showCaption="true"} The email address that was entered from *Step 4a: Set up an Email Alert* will also receive the respective alert email. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/4yicIObGDEErFdRPDRwUk_image.png" size="80" width="1055" height="532" caption="Sample email that LEM will send out" position="center" showCaption="true"} [title] Step 3: Establish Secure Connection Between Primary and Secondary Catalog [path] How-To Guides/Litmus Edge Manager User UI Guides/Deploy Edge Applications to Multiple Sites Using Marketplace Catalog Sync/ You need to establish a secure connection between the primary and the secondary catalog to synchronize the applications. A **JSON bootstrap** file is used by the *Secondary *catalog to activate the connection with the *Primary *catalog. **To download the Primary marketplace catalog bootstrap file: ** 1. From the primary marketplace catalog's *Applications *pane, click **Synchronization**. The *Synchronization: Primary Catalog *pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/QtFapcsutAwaxKDDyllAG_image.png "Synchronization: Primary Catalog pane") 2. From *Expiration within:* customize the desired duration for the bootstrap credential file. 3. Click **Generate**. A `.bootstrap` file will be downloaded to your local computer. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/BOXayB9hlkOwFAn_jmqGQ_image.png "Synchronization: Primary Catalog pane") Once you have downloaded the `.bootstrap` file, you need to upload it to at least one *Secondary *marketplace catalog. This should be done on Litmus Edge Manager located in Japan. **To upload the bootstrap credential file to Secondary marketplace:** 1. From the secondary marketplace catalog's *Applications *pane, click **Synchronization**. The *Synchronization: Secondary Catalog* pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/_LaApNc_LXeFxxUWxopK7_image.png "Synchronization: Secondary Catalog pane ") 2. Click **Upload**. Then, navigate to the `.bootstrap` file you downloaded earlier from the previous step and select it. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/SuTtDhi2GbBUwEP2zVC24_image.png "Upload the .bootstrap file to Synchronization: Secondary Catalog pane ") 3. Confirm the *Certificate *information and click **Yes**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CPcc58K1hw5rhWCDQlC-G_image.png" size="70" width="607" height="533" position="center" caption="Certificate information pane" showCaption="true"} 4. You need to **approve **the connection request for the *Secondary* Catalog from the *Primary *Catalog pane. To do this, go back to the *Synchronization* page in the *Marketplace Catalog* of the first Litmus Edge Manager Instance. Then, select **Secondary Catalogs.** ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/YK0F3FqCk2ObKSEUK0Vyo_image.png "Synchronization page for first Litmus Edge Manager Instance") 5. You will receive a request from the secondary catalog to synchronize applications from the primary catalog. Click the **Actions** menu and select **Approve**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0Mvnib1tbbDa9ln62ZSUh_image.png "Approve connection request for sync") 6. If successful, the upload process status will display as **Approved **in both the *Primary *and *Secondary Catalog Synchronization* pages. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1fDoO3fdJJEqEnt_mgkc7_image.png "Approved Status in the Secondary Catalog Synchronization page") ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/33_i6JljTKJV1Adt7VN_0_image.png "Approved Status in the Primary Catalog Synchronization page") A successful connection has been established between the primary catalog located in Canada and the secondary catalog located in Japan. **Next:** [Step 4: Synchronize Secondary Catalog to Primary Catalog](docId\:ILFE6vhXxhgSqhuISb8Dl) [title] Step 1: Create Primary Catalog With List of Applications [path] How-To Guides/Litmus Edge Manager User UI Guides/Deploy Edge Applications to Multiple Sites Using Marketplace Catalog Sync/ From the first Litmus Edge Manager (LEM) instance located at the Headquarters (Canada), you will create a *Primary *marketplace catalog and then add the applications. **To create primary marketplace catalog with list of applications:** 1. Log in to Litmus Edge Manager. 2. Select a **company**. The *Projects *pane appears. 3. From the *Projects *pane, click a project or open the **Action menu** for a project and select **View**. The *Dashboard *pane appears for the project. 4. From the navigation panel, select **Features**. The *Features* pane appears. 5. Click the **Marketplace** tile. The *Marketplace Catalog* pane appears in a separate browser tab. 6. Click **Add catalog**. The *Create Catalog *dialog box appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/EmHpsJSIVGndrYLnz50Qr_image.png "Marketplace Catalog page") 7. From the *Create Catalog *dialog box, enter the following details: - **Name: **Enter a name with a maximum of 32 characters. - **Description**: Enter the description for the catalog. - **Synchronize:** Select the checkbox. Then, from the *Select Role* drop-down list, select **Primary.** - Click **Save**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/wHnMAhzxkiAYP22B7fsrX_image.png" size="80" width="940" height="409" position="center" caption="Create Catalog dialog box" showCaption="true"} 8. Click the **Primary** marketplace catalog card you just created. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/dRKaQrRHpIUHNkJ-QhNiI_image.png " Primary marketplace catalog card") 9. From the *Applications *pane for the selected marketplace catalog, click **Add or Import an application**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1hA8iV0ieYfKKPHgZd4l0_image.png "Applications pane") 10. From the *Add Application *dialog box, enter the following details: - **Name: **Enter the name of the application. - **Attach Application Icon:** Upload an visual image to represent the application. - **Category: **Enter category for the application. - **Description:** Enter description for the application. - **Import: **(Optional) Upload a *JSON* configuration for the application. - Click **Save**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/o2XduoDZTXuKjq3mhjIf9_image.png" size="70" width="735" height="587" position="center" caption="Add Application dialog box" showCaption="true"} 11. Click the **Application** card you just created and add a draft application release. See [Application Releases](docId\:V_JC6NJ8Hu8R756NNEr7n) to add multiple release versions to your application. The *Application *card will look like below screenshot after adding multiple release versions. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/lkA6S_BKqPQ6J6kZWxonc_image.png "Application card ") 12. To add more applications and their respective release versions, you can repeat the process from *steps 9-11*. The *Applications *pane looks like below after adding a list of applications. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/iO5xjSKGDd49gOAtURlHq_image.png "Applications pane") The LEM with the *Primary *marketplace catalog at the Canadian headquarters is now ready to synchronize with the Secondary marketplace catalog located in Japan. **Next:** [Step 2: Create Secondary Catalog](docId\:ZO8hyYhJOLAEiH2tHM7-W) [title] DigiCert [path] Litmus Edge Manager Admin Console/Product Features/Integration/ :::hint{type="info"} **Note**: The DigiCert feature is available for Litmus Edge Manager 2.21.0 and later. ::: Litmus Edge Manager (LEM) allows you to centrally manage certificates to ensure encrypted end-to-end communication over TLS (Transport Layer Security). By providing users with the ability to seamlessly view and control certificates across all active Litmus Edge instances, LEM facilitates the streamlined management of self-signed certificates directly within the platform. The DigiCert IoT Trust Manager integration helps users easily manage, renew, and resolve problems with certificate expiration. It also simplifies certificate administration for managing edge devices. # Access DigiCert UI **To access the DigiCert UI: ** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Integration**. Integration's *Kafka* pane by default appears. 3. From Integration's navigation sub-panel, select **DigiCert**. Integration's *DigiCert* pane appears. Refer to the following actions you can take on Litmus Edge Manager Admin Console's *DigiCert *pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/p7S3QDc6ZNvF2MghW1jD9_image.png "DigiCert IoT Trust Manager") | **Action** | **Details** | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | \[1] **DigiCert server URL** | This parameter is the DigiCert server URL used for communication with the DigiCert IoT Trust Manager. See [Manage Certificates with DigiCert IoT Trust Manager Integration](docId\:WMPXv5e6D8dZWNeUjiFTE) to learn more. | | \[2] **Enrollment Profile ID** | This parameter is a unique identifier for the Enrollment profile used for authenticating with the DigiCert IoT Trust Manager. See [Manage Certificates with DigiCert IoT Trust Manager Integration](docId\:WMPXv5e6D8dZWNeUjiFTE) to learn more. | | \[3] **Enrollment Passcode** | This parameter is a one-time generated code used for authentication between the Litmus Edge Manager Admin Console and the DigiCert IoT Trust Manager. See [Manage Certificates with DigiCert IoT Trust Manager Integration](docId\:WMPXv5e6D8dZWNeUjiFTE) to learn more. | | \[4] **Validate** | Button to validate the DigiCert integration settings and ensure successful communication with DigiCert IoT Trust Manager. | [title] Incidents [path] Litmus Edge Manager Admin Console/Product Features/Alerts/ The **Incidents** tab provides a single view of all triggered incidents across every company, project, and edge device in the instance. From this page you can monitor system-wide operational health, investigate alert history, and resolve open incidents without switching between tenants. Access incidents in **Alerts** > **Incidents**. :::hint{type="info"} **Note:** The Incidents page is an Admin Console feature and shows incidents across all tenants. For project-level incident management, see [Alerts](docId\:BWq6oBkuTNZgIJBIgQPBE) for the Litmus Edge Manager User UI. ::: Each incident entry includes: | Column | Description | | -------------------- | ---------------------------------------------------------------------------------- | | **Trigger** | The alert trigger that fired the incident. | | **Scope** | The company, project, and edge device where the incident occurred. | | **Incident Message** | The message associated with the alert trigger. | | **Started At** | The date and time the incident began. | | **Resolved At** | The date and time the incident was resolved. No value displays for open incidents. | | **Status** | The current state of the incident: **New** or **Closed**. | | **Action** | Options menu to resolve the incident. | # Filter and Sort Incidents Click the filter icon in any column header to narrow results, for example, by **Status** (All, New, or Closed) or a **Started At** date range. You can also sort any filterable column. To reload the list, click the reload icon at the top right of the page. # Resolve an Incident To resolve an open incident, click **Resolve** in the **Action** column for that row. The incident status changes to **Closed** and the **Resolved At** timestamp is populated. [title] Disconnect an Edge Device [path] How-To Guides/Litmus Edge Manager User UI Guides/ You can disconnect your Edge device from your Litmus Edge Manager (LEM) when it is no longer needed. Follow these steps to disconnect an Edge device. # Before You Begin Ensure you have at least one Edge device activated in your Litmus Edge Manager. See [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) for more information. # Step 1: Navigate to Edge Devices From your LEM dashboard, open the **Edge Devices** page.  ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/c-gROLP8D_IpxnERx1Ltk_image.png "LEM edge devices page") # Step 2: Deactivate the Device You must first deactivate the device before disconnecting it from LEM.  **To deactivate an edge device:** 1. For the Edge device you want to disconnect, click the **Action menu** and select **Deactivate**. The *Deactivation* dialog box appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/LcsRiSle0I22b60OZ1px5_x.png "LEM edge devices list of active devices") 2. Select the checkbox to *Force deactivation *and click **DEACTIVATE**.  ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/jcL-k6B8zFWaUHbHw_sQ6_ax.png "Edge device deactivation confirmation dialog box") :::hint{type="warning"} **Caution:** Deactivation is an irreversible process. If not done carefully, you may lose all device configurations. ::: # Step 3: Remove the Device Once you have deactivated the device, you can safely remove it. **To remove an edge device:**  1. Navigate to the* Edge Devices* page again. 2. Click the **Action menu **and select **Delete**. The *Deletion *dialog box appears. 3. To remove the device permanently, click the **DELETE **button. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/78UsdaaJnLgAR6vRj39_A_warr.png "Edge device deletion confirmation dialog box") Confirm that the disconnected device is no longer in the *Edge Devices* table. [title] Company Settings [path] Litmus Edge Manager User UI/Product Features/LEM Settings/ Companies are the main organizational unit that you can define. They contain the following: - Company teams that define company-wide access privileges. - Company projects, which can represent individual plants that a company operates. # Company The *Company *tab includes the Settings, Company Teams, Team Members, and Remove Company sections. ## Settings Modify the company name, and add or modify the company description. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/-1aF2FpcILVyVTSP40wJv_image.png" size="80" width="1398" height="358" position="center" caption=" Company tab: Settings" showCaption="true"} ## Company Teams Add, modify, and delete a company team. You cannot modify or delete the company team called `OWNER`. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0FWBLpR2G5VnBKdmnYUTI_image.png" size="80" width="1397" height="216" position="center" caption="Company tab : Company Teams" showCaption="true"} Make sure you have added at least one company. Members of the `OWNER` Team have permission for all features and options. ## Team Members Add and remove members for a selected company team added in the *Company Teams* section. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Jqjy7RkhmTdYyeFlSevBb_image.png" size="80" width="1774" height="164" position="center" caption="Company tab: Team Members" showCaption="true"} When adding a new company team member user, the new user will be in one of two states: - `PENDING`: The user has not responded to the invitation email. - `ONBOARD`: The user has responded to the invitation email. When the user confirms the invitation, they are directed to an open instance of the company in a new tab on their browser. :::hint{type="info"} **Note**: The invitation email will not be sent to the new user if SMTP is disabled, see [Email](docId\:GcxRXKR3-oc_O9zqz7Jke) to enable. ::: ## Remove Company Remove the selected company. Before you can remove a company, you must remove all the associated projects. Removing a company cannot be undone. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/IzYh4kVuvi37dWuK8zCZk_image.png" size="80" width="1398" height="85" position="center" caption="Company tab: Remove Company" showCaption="true"} Prior to removal, all projects within a company must be deleted first (see [Remove Project](docId\:hmGSXiivMvDy4K43OanRv) for details) to remove a project. This operation will delete all related resources and they cannot be restored. After deleting a company, you cannot reuse the company name. # Projects The Projects tab includes the Project List and Project Teams sections. ## Project List Add, modify and remove a project associated with the selected company. **** ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Sv6OjxWLePOGbEZkCvG8X_image.png" size="80" width="1767" height="168" position="center" caption="Projects tab: Project List" showCaption="true"} :::hint{type="info"} **Notes**: - The project name must be alphanumeric and cannot include spaces or special characters. - Removing a project removes all related resources and they cannot be restored. ::: ## Project Teams Add and remove a team with a selected role for a selected project that is associated with the selected company. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/2ONIb46rGz_gxfHc1ZdV3_image.png" size="80" width="1771" height="171" position="center" caption="Projects tab: Project Teams " showCaption="true"} When adding a project team, make sure you have added a project first. [title] Upgrade [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ Refer to [Software Update](docId\:hzLOrWMFP3cGa8OvH_njo) to learn how to manage software updates of Litmus Edge Manager. [title] Litmus Edge Manager User UI Guides [path] How-To Guides/ [title] Admin Console Settings [path] Litmus Edge Manager Admin Console/Product Features/ The Settings module allows you to manage the settings for your Litmus Edge Manager (LEM). [Domain/SSL](docId\:MC8Z1bK3yWcKQq4-kupCv) - **Domain**: Update base domain name and view the domain process log. - **SSL Settings**: Select and configure an SSL setting and view the SSL process log. - **Edge Remote**: Manage edge remote endpoint. [Cloud](docId\:Tcs7sRvoORXHg5UzOyVSP) - **Cloud Credentials**: Set cloud provider credentials. - **Rotation: **Set GCP SA Key rotation policy. - **Storage Settings**: Manage storage type, either local or cloud bucket. [Network](docId\:VVhYuAY0vwQsvIea6MF9Q) - **Interfaces**: Add/Update interfaces for the LEM. - **DNS**: Set up the DNS that LEM will connect to. - **NTP**: Set up LEM as NTP Server/Client. - **Proxy Settings**: Add host information for the HTTP or HTTPS protocols. [Email](docId\:GcxRXKR3-oc_O9zqz7Jke) - **Email Settings**: Enable or disable SMTP, enter host information and port information, and use authentication to send emails. [Admin Console Licenses](docId\:dMpF2PJbBM7kQQgs0lVUC) - **Available Licenses**: View the applied licenses for Litmus Edge Manager. - **Features**: View the enabled features associated with your applied licenses. - **Online Activation**: Activate a license if you are connected to the internet. - **Offline Activation**: Activate a license if you not connected to the internet. [Users](docId\:m4I7KMG5bHSaTUxJNwMZ5) - **Administrator**: Update administrator password. - **Users**: Add, edit or remove users. - **Company Teams**: Add and remove teams for a company, and add and remove users for a selected company team. - **Project Teams**: Add and remove project teams for previously added company teams, and assign roles of n/a, read, or write to the selected project team. [Tokens](docId\:sHLyvAfrLOR7KkOopqV4N) - **Tokens**: Generate and manage long-time tokens for connecting to Litmus Edge Manager. [Upgrade](docId:-C0COf-HLIWthd8s3U2zp) - **Current Version**: View the current Litmus Edge Manager version, the date and time it was applied, and the modules available for the version. - **New Version**: View uploaded Litmus Edge Manager versions, the date and time they were uploaded, the version size and encryption for the uploaded version. You can delete an uploaded version or use it to upgrade your current version. - **Upload**: Upload a Litmus Edge Manager version. [Support](docId\:b_UKFjBuLxq7q7liWxVkJ) - **Current Version***:* View the details for the current version of Litmus Edge Manager. - **Validation**: Run validation script to check instance health. - **Support**: Download support bundle files for a support ticket. [Export/Import](docId:1VIPA5Py1DmcBoB5hDZMy) - **Export Data**: Download a file containing Litmus Edge Manager instance data. - **Import Data**: Upload a file containing Litmus Edge Manager instance data. - **Log**: Display process log of the above Export/Import operations. [Admin Console Backup](docId\:OpbSMI-B4XBzqTIePSHLn) - Download and upload Litmus Edge Manager instance configuration settings. Available for Litmus Edge Manager version 2.15.0 and later. [Experimental Features](docId\:PtIJysv_x6gV1g0Z4oR2B) - **Experimental Features**: Enable or disable the experimental features for Litmus Edge Manager. [Management](docId\:VzYNhoUsLtjETO0F1aFa1) - Reboot Litmus Edge Manager. Available for Litmus Edge Manager version 2.15.0 and later. [title] Admin Console Dashboard [path] Litmus Edge Manager Admin Console/Product Features/ The Dashboard provides you with a comprehensive overview about the Litmus Edge Manager. From the *Dashboard* pane, you can view the total number of companies, projects, Litmus Edge, total database size and total number of messages. It includes charts, graphs, and statistics for System Overview, CPU, and Disk Usage. # Access Dashboard UI **To access the dashboard UI:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Dashboard**. The *Dashboard* pane appears. The user interface below is for Litmus Edge Manager version 2.10.1 and later. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/nLE6ly-ELjXiuUXKap66H_image.png" size="80" width="1920" height="866" caption="Litmus Edge Manager Admin Console Dashboard Global View" position="center" showCaption="true"} # Dashboard Deployment and Messages Chart From the main Dashboard Deployment heading, it provides an overview about which edge device deployments are configured on the Litmus Edge Manager. It also allows you to monitor how the edge device deployments influence the resources like CPU, Disk storage or Network traffic of Litmus Edge Manager and take action to ensure the highest availability. You can view: - The number of Companies - The number of Projects - The number of edge devices, including statistics like Total bytes transferred and Total Messages transferred. The Messages chart allows you to monitor the quantity of messages received over time. This allows you to identify slack time or anomalies in the quantity of data received from your edge devices. You can view statistics for the quantity of edge device messages received at a given time from this chart. You can view a point in time for the chart. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/DryTxe4HqidsuRLp1wyD3_image.png" size="80" width="1895" height="285" position="center" caption="Dashboard Deployment" showCaption="true"} ## System Time / Local Time Warning :::hint{type="info"} **Note**: The *System* *Time* / local time warning feature is available for Litmus Edge Manager version 2.10.1 and later. ::: If the Litmus Edge Manager's *System Time* differs from your device's local time by 10 minutes, a warning will be displayed. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/lxi44zI3WcYiOe8me3Dwf_image.png" size="80" width="1832" height="161" caption="System and Local Time" position="center" showCaption="true"} To synchronize the local time and *System Time*, you will need to configure one or both of the following: - Fix the local time of your device (the device you're using to access Litmus Edge Manager). - Fix the Litmus Edge Manager's *System Time. *To do this, under [NTP Client Settings](docId\:hRmAskLSu9CAdrlP7k-UE)*,* you will need to specify and add the proper external NTP Server(s) that the Litmus Edge Manager will connect to. # Project Statistics From the** ***Project Statistic* table, you can view a table showing: - The company name - The project name - The quantity of edge devices associated with the project - The number of bytes used for a project - The number of messages received for the connected edge devices - The instances of Consumer Lag Device Data (the delta between the Latest Offset and Consumer Offset) ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/41zCGieWdpLC_kXRd3yhc_nv7lwdgicxuacqtaisw4nimage.png "Project Statistics") [title] Export/Import [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ You can export and import data that is collected from a Litmus Edge Manager instance from the *Export/Import* module. Export data files may use encryption by adding a user-defined password. You can upload data files from your hard drive. You can view logs of the latest export/import operation logs with an option to auto scroll. The user interface below is for Litmus Edge Manager version 2.15.0 and later. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Rnhrd2NhlTbIbucMP20iB_image.png "Export/Import Data UI") # Export Configuration :::hint{type="info"} **Note**: This option is no longer available from *Export/Import Data* for Litmus Edge Manager version 2.15.0 and later. To download an instance configuration, navigate to **Settings **> **Backup**. ::: You can download an instance configuration from the *Export Configuration*** **section in the *Export / Import* module. Configuration files are password protected and generated as a `.tar` file. Process logs are visible in the *Log* section. To export the configuration, you'll need the password of the Litmus Edge Manager instance. # Export Data You can download an instance data file from the *Export Data* section in the *Export / Import* module. To export the data, you'll need the password of the Litmus Edge Manager instance. # Import Configuration :::hint{type="info"} **Note**: This option is no longer available from *Export/Import Data* for Litmus Edge Manager version 2.15.0 and later. To import an instance configuration, navigate to **Settings **> **Backup**. ::: You can upload a configuration bundle from the *Import Configuration* section in the *Export/Import* module. To import the configuration, you'll need the password of the Litmus Edge Manager instance. Importing a configuration replaces configuration data and cannot be undone. Select the appropriate bundled zip file. # Import Data You can upload a data bundle from the *Import Data *section in the *Export/Import* module. To import the data, you'll need the password of the Litmus Edge Manager instance. If a configuration already exists, as a best practice, you should export the data prior to using upload so you can revert, or you can create a backup of the entire system. Replacing the existing data files cannot be undone. Select the appropriate bundled zip file. # Log You can view the latest export/Import operation log from the *Log *section in the* Export/Import*** **module. You can toggle **Auto-scroll** to the **On **position to automatically scroll down to the most recent messages in *Process Log*. Doing so helps monitor a running export/import process. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/JDGw2KNWXg10XjyJkRV-i_image.png" size="80" width="1495" height="870" caption="Process Log " position="center" showCaption="true"} [title] Edge Device Templates [path] Litmus Edge Manager Admin Console/Product Features/Edge Devices/ The *Template List* provides you with an overview about available templates. From the Templates List, you can access all templates available for different companies, projects, or instances from the Admin Console. Three scopes are defined for a template: - **Instance**: The template can be applied to all companies and projects for this Litmus Edge Manager - **Company***:* The template can be applied to all projects for a company - **Project**: The template can be applied to all device for this project For each template, the following displays: - **Description**: A description of the template. - **Template Scope**: This determines where templates can be applied in the Litmus Edge Manager. - **Company**: The company for which the template can be applied. - **Template Statistics**: Display additional information about the components of the edge device included in the template. - **Created At**: The date the template was uploaded to Litmus Edge Manager. - **Parameterized**: Indicates if the selected template is simple or parameterized using False and True respectively. - **Action**: Allows you to select the following actions for each template: - Edit template - Download template - Delete Templates are created externally and can be uploaded from a file. Simple templates are used to duplicate the field data for one instance, company or project to multiple other instances, companies or projects in Litmus Edge Manager. This comes in handy when most field data is the same. For example, if most configuration information for devices in the same project are the same, you can use a simple template when adding new devices to the project. Parameterized templates are used when you want to change specific names or types of configuration information for instances, companies or projects. For example, if some of the configuration information for devices, such as the name, in the same project are different, you can use a parameterized template when adding new devices to the project. # Access Edge Device Templates UI **To access the edge device templates UI:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Edge Devices**. Edge Device's *Edge Software Update* pane by default appears. 3. From Edge Device's navigation sub-panel, select **Edge Devices Templates**. Edge Device's *Edge Devices Templates* pane appears. Refer to the following actions you can take on Litmus Edge Manager Admin Console Edge Device's *Edge Device Template* pane. The user interface below is for Litmus Edge Manager version 2.11.0 and later. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/_LovsttRjOwx9CLULIm7l_hwzx4t25i0xx70t9fmfrkimage-1.png "Litmus Edge Manager Admin Console: Edge Template List") | **Action** | **Details** | | ------------------------------------------------- | -------------------------------------------- | | \[1] **Show filter **/ **Hide filter ** | Search by *Description* or *Company* | | \[2] **Upload Template** | Simple Template or Parameterized Template | | \[3] **Action menu** | - Edit Template - Download Template - Delete | | \[4] **View Template Statistics** | Display the details of templates. | # Upload Templates You can upload a *simple* or *parameterized* template from the *Templates List* section. ## Simple Templates Simple templates are used to duplicate the field data for one instance, company, or project to multiple other instances, companies, or projects in Litmus Edge Manager. This comes in handy when most field data is the same. For example, if most configuration information for edge devices in the same project is the same, you can use a simple template when adding new devices to the project. ## Parameterized Templates Parameterized templates are used when you want to change specific names or types of configuration information for instances, companies, or projects. For example, if some of the configuration information for devices, such as the name, in the same project is different, you can use a parameterized template when adding new devices to the project. The simple template is uploaded as a JSON file, and the parameterized template is uploaded as a ZIP file. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/orXXeEsUDkHOp9UAN5s8z_image.png" size="80" width="976" height="309" caption="Litmus Edge Manager Admin Console : Upload Templates" position="center" showCaption="true"} | **Action** | **Details** | | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Select Simple** **Template (JSON) **/ **Parameterized Template (.ZIP)** | You can upload a software image using a file or a signed URL. Example file name can be : `litmusedge-std_3.1.7.0-amd64.upd` or `Litmusedge-std_3.1.7.0-amd64.upd.sig` | | \[2] **Select File** | Browse and choose your template file. | | \[3] **Enter Description** | Provide details for the uploaded template. | | \[4] **Cancel** | Abort the upload process if needed. | | \[5]** Upload** | Initiate the template upload action. | [title] Edge Devices [path] Litmus Edge Manager Admin Console/Product Features/ Refer to the following edge device management features. - [Edge Devices](docId:0kuXNK1e4igb0FxBRnghJ) - [Edge Software Update](docId:3IevluZfOdrXAqOOpVT1n) - [Edge Device Templates](docId\:nNxhGGYezqqsdyajOkc8F) - [Edge Password Policies](docId\:nZxdm63Ip1guJ_mQiN140) - [Edge Remote Networks](docId\:aftGosdXRCw2Tz9d5Gtzg) - [Node-Locked Licenses](docId\:c0-d2jkjFVytbWDoL9FRr) [title] Marketplace: Catalogs and Applications [path] Litmus Edge Manager User UI/Product Features/ The Marketplace is a catalog repository that includes a default catalog. A catalog is a collection of Docker applications that can be configured as needed before being deployed to Litmus Edge instances. You can deploy both public and private catalogs, and then deploy applications for various uses. The default catalog is preloaded with applications, such as visualization, user interface reporting, business intelligence, programming, server, and database tools. From the Marketplace Catalog browser pane, you can add, edit, or delete marketplace catalogs. You can modify the default marketplace catalog, but not delete it. Marketplace uses access control based on user roles for access to catalogs. Users cannot access the catalogs of other users unless they have full access privileges. # Access Marketplace UI **To access the marketplace UI:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects *pane appears. 3. From the *Projects *pane, click a project or open the **Action menu** for a project and select **View**. The *Dashboard *pane appears for the project. 4. From the Navigation panel, select **Features**. The *Features* pane appears. 5. Click the **Marketplace** tile. The *Marketplace Catalog* pane appears in a separate browser tab. The default catalog displays, along with any other added catalogs. Refer to the following actions you can take on the Litmus Edge Manager User UI's *Marketplace Catalog* pane. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CViobNRX5DlH818S-ZcMh_image.png) - **View applications in this catalog** Display all applications in the catalog. - **Action menu** - **Edit:** Modify a Marketplace catalog. - **Export:** Export a Marketplace catalog in JSON format. When you export, you can choose whether to include registries with the export. - **Delete:** Removing a Marketplace catalog also removes its associated applications. This cannot be undone. - **Add Catalog** Name has a maximum of 32 characters. - **Change Catalog View** Update the catalog view from **Tile View** to **List View**. ## Synchronize Catalogs :::hint{type="info"} **Note**: The Synchronization feature is available for Litmus Edge Manager 2.11.0 and later. ::: When you add a new catalog, you can also customize it as a synchronized catalog. See [Synchronization](docId\:jaznCrFR8oKorD6QyGKXt) for more details. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/gYfF1Hkl6Z7oAiyy6tdv__image.png" size="80" width="974" height="340" position="flex-start" caption="Create catalog dialog box" showCaption="true"} | **Action** | **Details** | | -------------------------------- | --------------------------------------------------------------------------------------------- | | \[1] **Toggle Synchronize** | You cannot change this setting after creating the catalog. | | \[2] **Select Synchronize Role** | - **Primary: **You may only have a maximum of one primary catalog. - **Secondary** | # Applications For a marketplace catalog, after clicking the catalog card (See *View applications in this catalog *from the previous section), you will be brought to the *Applications *pane for the selected marketplace catalog. Every catalog contains a collection of associated Docker applications. The default marketplace catalog contains the following ten Docker applications: - Elasticsearch - Grafana - KDB - Minio - MongoDB - Microsoft SQL for Linux - MySQL - PipelineDB - PostgreSQL & Adminer - Python You can customize a catalog and its applications as needed. You can add, modify, and delete applications for the currently selected catalog. The currently selected catalog’s Docker applications are displayed as below. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/xqrkDvGjkitSW5Sq3_7zk_image.png" size="80" width="1919" height="501" position="flex-start" caption="Catalog Applications" showCaption="true"} | **Action** | **Details** | | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **View Registry Management** | ****[Registry Management](docId\:M6yzedYRAwwYDnLDtOQlZ) | | \[2] **View Application** | ****[Application Releases](docId\:V_JC6NJ8Hu8R756NNEr7n) | | \[3] **Action menu** | - **Edit** - **Delete: **Removing a marketplace catalog also removes its associated applications. This cannot be undone. - **Export: **`.json` file | | \[4] **Add or Import an application** | The **Select Icon **option is an optional feature that allows you to select an visual image to represent the application. Litmus Edge instances that later receive this Docker application will also receive the same visual image.
- Example category: Utils, Database, Programming, Server | | \[5] **Change Application View** | Alter the view of application. | # Next Steps - [Application Releases](docId\:V_JC6NJ8Hu8R756NNEr7n) - [Registry Management](docId\:M6yzedYRAwwYDnLDtOQlZ) - [Synchronization](docId\:jaznCrFR8oKorD6QyGKXt) - [Deploy Edge Applications to Multiple Sites Using Marketplace Catalog Sync](docId\:Z8R_5mVU1pezFXVSeNhQu) [title] Support [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ # Current version You can view the details for the current version of Litmus Edge Manager from the *Current Version* section by expanding it. In this section you can view the following: - The version, date, and time of installation. - Components and build. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/p8UkBHNqjaXjBzuaONg85_image.png" size="80" width="928" height="221" position="flex-start" darkWidth="928" darkHeight="221" showCaption="false" indent="2"} # Validation You can validate the operational status of the Litmus Edge Manager. Use this to diagnose the health of the Operating System, component status, and system service statuses. From the *Validation Log* dialog box, click the **Show full log** toggle switch to see the full validation log. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3HH31IIW6iC-2uYLUm5sM_image.png" size="80" width="1715" height="184" position="flex-start" caption="Validation" darkWidth="1715" darkHeight="184" showCaption="true"} # Support Bundle The support bundles are primarily used for diagnostic purposes. They should be attached as part of a support ticket when contacting customer support. Support bundles are then reviewed by customer support. The support bundle is a collection of all relevant log files, which are packed into a `.zip` file and can then be shared with Litmus to assist in troubleshooting. Files in a support bundle are password protected. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/yKNPQVtildJyk7JpbVFvc_image.png "Support section") [title] Step 5: Deploy an Application from Secondary Catalog to Edge Devices [path] How-To Guides/Litmus Edge Manager User UI Guides/Deploy Edge Applications to Multiple Sites Using Marketplace Catalog Sync/ Once synchronization is successfully completed, the secondary site situated in Japan receives the same versions and releases of software as their headquarters in Canada. This allows engineers working in Japan location to deploy any application from their synchronized catalog to multiple edge devices on their sites. **To deploy an application from secondary catalog to edge devices:** 1. From the* Litmus Edge Manager User UI*, select the appropriate company and project. Then, navigate to **Applications**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/FBUCC3NJhuQ_uO8Qbs_54_image.png "Applications page") 2. From the *Catalog* menu, select the **Secondary** marketplace catalog you created in [Step 2: Create Secondary Catalog](docId\:ZO8hyYhJOLAEiH2tHM7-W). 3. Click the **Actions **button for *Analytics *application and click **Launch App**. The *Application master: Step 1 - Select at least one online device* dialog box appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/hFmhsvF8YLGWFU8TX6pkp_image.png "Applications pane") 4. Check the **box **for one or more Litmus Edge instances on the *EDGE DEVICES* tab and click **Next**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/sZHO64yy1nwIldEwzvRNR_image.png" size="80" width="965" height="720" position="center" caption="Application master: Step 1 - Select at least one online device dialog box" showCaption="true"} 5. From the *APP SETTINGS *tab, complete the following steps: - Enter the **Application Name**. - Select the **Application Release** version from the drop-down menu. - (Optional) Configure **Parameters **such as *Port *and *API Token *based on the selected application for deployment. - Click **Next**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/zGlnnvWeBvpc5INVqtghb_image.png" size="80" width="972" height="716" position="center" caption="Application master: Step 2 - Application Settings dialog box" showCaption="true"} 6. From the *PREVIEW *tab, review the *Summary *of the deployment and click **Launch **to deploy the application. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Ia6WWXJAKOZk_l-NWub5o_image.png" size="80" width="977" height="717" position="center" caption="Application master: Step 3 - Preview dialog box" showCaption="true"} 7. To confirm a successful deployment, go to the *RESULTS *tab and check the *Status *column. If it shows *Success*, click on **APP DETAILS**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/UMY_Q74HrjXVc2kczbFga_image.png" size="80" width="980" height="723" position="center" caption="Application master: Step 4 - Results dialog box" showCaption="true"} 8. The *Application Details* page provides information about your deployed application. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/kj1Ex_vZf3zopQ0Z7CT90_image.png "Application Details page") 9. Log in to the Litmus Edge instance used for deployment, and navigate to **Applications** > **Catalog Apps**. The *Running *status confirms that the application with the same release version was deployed successfully. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ZO9uctMfsYOicskF72kHN_image.png "Applications > Catalog Apps page") **Next: **[Step 6: (Optional) Update an Application Version](docId\:iQ9xXw9m86Q7KzajiMQQt) [title] Network [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ :::hint{type="info"} **Note**: The Network feature with four tabs is available for Litmus Edge Manager 2.8.0 and later. Previously, it contained Remote Networks(deprecated) and [Proxy Settings](docId\:x6zEmtj6xRguKRi84Dja8). ::: This section covers network settings for Litmus Edge Manager Admin Console, with the following four tabs. - [Interfaces](docId\:SO6RFAPUk4c047l6h1A1J) - [DNS](docId\:aTT90pnPsBREQawmMTKc_) - [NTP](docId\:hRmAskLSu9CAdrlP7k-UE) - [Proxy Settings](docId\:x6zEmtj6xRguKRi84Dja8) **** **** [title] Edge Software Update [path] Litmus Edge Manager Admin Console/Product Features/Edge Devices/ The *Edge Software *module provides you with all the tools needed to manage updates and upgrades of the edge devices managed by Litmus Edge Manager. You can upload the `.upd` file onto the admin console once and it can be used to upgrade edge devices using the Litmus Edge Manager Admin Console *Software update *options. All the images that you load onto the admin console are available for edge device upgrades. You can create groups of edge devices and update them at a specific time or immediately using the upgrade options. You can ensure that edge devices are running on the latest version, manage the disk space used, and view a history of updates. The Software Images list shows: - **Product:** The product name - **File Name:** The name of the `.upd` file - **Size:** The file size for the `.upd` file - **Version:** The version of the product - **Platform:** The platform type # Access Edge Software Update UI **To access the edge software update UI:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Edge Devices**. Edge Device's *Edge Software Update* pane by default appears. Refer to the following actions you can take on Litmus Edge Manager Admin Console Edge Device's *Edge Software Update* pane. The user interface below is for Litmus Edge Manager version 2.10.1 and later. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/GCXs9apGShzAad9BdE7UL_79v86dkfwjysmvboh5jukimage-1.png "Litmus Edge Manager Admin Console: Edge Software Update") | **Action** | **Details** | | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Upload Edge Software Image ** | You can upload a software image using a file or a signed URL. Example file name can be : `litmusedge-std_3.1.7.0-amd64.upd` or `Litmusedge-std_3.1.7.0-amd64.upd.sig` | | \[2] **Action menu:** | - Remove | | \[3] **Copy ** | * Checksum to clipboard | # Troubleshooting ## Firefox Upload Error When using the Litmus Edge Manager Admin Console with Firefox to upload a software image, an error can occur due to a problem with the way Firefox manages certificates. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/R_URmSBUDT7FlsajFrA0U_image.png" size="80" width="565" height="157" caption="Failed HTTP response during Firefox Upload " position="center" showCaption="true"} Litmus Edge Manager uses a self-signed Certificate. This prompts the browser to display an error message. Follow the browser guidelines for how to bypass a self-signed security error message. ## Resolution To resolve this issue, the certificate for the **Minio** application, which manages the uploaded images, must be accepted. **To accept the certificate for the port 8445:** 1. From the Firefox web browser, enter the IP address and port `8445` (for example, `https://192.162.2.18:8445`) in the URL bar, and then press **ENTER**. 2. Click **Advanced** 3. Click **Accept the Risk** and **Continue**. 4. **Close **the browser tab. No login is required. [title] Domain/SSL [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ The **Settings **>** Domain/SSL** pane is used to configure the domain name, SSL, and Edge Remote endpoint in Litmus Edge Manager. This pane includes the following sections: - Domain - SSL settings - Edge Remote # SSL Certificate Workflow You can choose between two methods for adding an SSL certificate to Litmus Edge or Litmus Edge Manager: 1. Manual request process 2. DigiCert IoT Trust Manager integration. ## Method 1: Manual Request Process ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/uizx2-MquqqqDYfwMjhN6_diagram-2-oct10th2024.png) - **Step 1**: You will need to request an SSL certificate from your IT team. - **Step 2**: Your IT team will make a request for the SSL certificate from a certificate authority (CA) (for example,Let's Encrypt, DigiCert). - **Step 3**: The CA will return the following to your IT team. - The root CA certificate file - Any required intermediate certificates - The SSL certificate file - **Step 4**: The IT team will send you the following. - The root certificate file - Any required intermediate certificates - The SSL certificate file - The private key file - **Step 5**: You will apply the following in either Litmus Edge Manager (see *SSL Settings *section below) or Litmus Edge (see [Add a Device Certificate](docId\:A6g-bo9xf4CHv6GYlYHxG)). - The CA chain file (root CA file and all intermediate certificates) - The SSL certificate - The private key file ## Method 2: DigiCert IoT Trust Manager Integration ![](https://archbee-image-uploads.s3.amazonaws.com/Q116WJTAr1sefeVNvMCF9-1R5eETi0pIm0sWLvRkuIT-20241009-191531.png) - **Step 1:** Set up DigiCert IoT Trust Manager integration through the Litmus Edge Manager Admin Console. - **Step 2: **Access DigiCert IoT Trust Manager to retrieve the URL, Profile ID, and Passcode, then configure the CA for Litmus Edge Manager (LEM) and Litmus Edge (LE). - **Step 3:** DigiCert IoT Trust Manager Handles the Entire Certificate Management Process including: - Issuing the SSL certificate - Managing the CA chain file - Private key file - **Step 4:** Apply and issue certificates to your edge devices through Litmus Edge Manager. # Domain Settings You can use the domain name to obtain access to Litmus Edge Manager without knowing the IP address. This helps when configuring settings: - **Base domain name**: The basic domain name is used by clients accessing the Litmus Edge Manager Admin Console, Litmus Edge Manager Application, and Keycloak application. ## Before You Begin Ensure a DNS server exists to handle requests by clients using the domain name. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/NgMFA0ZiSiGBdreqwBXDu_image.png" size="80" width="1919" height="218" position="center" caption="Domain/SSL: Domain" showCaption="true"} | **Action** | **Details** | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | \[1] **Edit Base Domain Name** | Changing the domain name can cause connection issues such as disconnecting all previously connected edge devices. It is recommended that you make DNS changes prior to configuring the rest of your settings. The domain name also causes an update to the certificates. It may be necessary to accept new certificates after reloading the current browser tab. See [Browser Access Restrictions ](docId\:F_4FUf7kbozItSH_LMXp4)for more information.
* If the domain name is valid, a green check mark displays. * If the domain name is invalid, a red exclamation mark displays. | | \[2] **Copy ** | - base domain name | | \[3] **View Domain Log** | Enabling auto-scroll is helpful when running an import process. | | \[4] **Save base domain name** | Save the base domain name | # SSL Settings There are three options when selecting an SSL setting: - **Instance Default Certificate**: Allows you to use the default self-signed SSL certificate that is automatically created during deployment when you first boot up for HTTPS, and MQTT SSL. - **Let's Encrypt Webroot mode**: The certificate is based on [Let's Encrypt](https://en.wikipedia.org/wiki/Let's_Encrypt) using their Webroot mode. You must enter the domain name for your web-server in the *Domain *section. An IP address cannot be used. This is used when the web-server is exposed to the Internet and should not be used for private networks. - **DigiCert: **The DigiCert option integrates with a unique passcode for each LEM instance, which should be securely stored and managed within the admin interface. This ensures a secure and reliable SSL certificate management process for your Litmus Edge Manager. - **User Defined***:* The SSL encryption uses a self-signed certificate (`.crt` or `.pem` file) and a (`.key` or `.pem` file) that has been uploaded to Litmus Edge Manager. The same certificate must be uploaded to the connected edge device. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/2MeN5OiOlXhj9YbKR_Joq_image.png "Domain/SSL: SSL settings") | **Action** | **Details** | | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | \[5] **Select SSL Setting** | - Select **Instance Default Certificate** to ensure that the SSL certificates that are used for the server and instances are valid and trusted by the server. - Select **Let's Encrypt Webroot** mode to secure publicly available content in a domain by encryption, and then click **Save**. It issues a certificate when ownership is proven. This selection requires that a domain name is set. This selection cannot be used with an IP address. - Select* ***User Defined** to use an SSL certificate and key file to secure content. A `.crt` or `.pem` file and a `.key` or `.pem` file is required for this selection. | | \[6] **(User-Defined Only) Upload SSL Certificate ** | Upload ssl cert file | | \[7] **(User-Defined Only) Key file ** | Upload key file | | \[8] **(User-Defined Only) Root CA Certificate** | Upload a CA chain file. Creating a CA (Certificate Authority) chain file involves consolidating the necessary certificates to establish a trust hierarchy for secure communication. To do this, you'll typically need the intermediate certificates that link your SSL certificate to the root certificate, ensuring a complete chain of trust. Begin by gathering the required certificates, which often include intermediate certificates, and the root certificate. Then, execute a command to combine all required certificates into a single file. See the example below. | | \[9] **View SSL Log** | Enabling auto-scroll is helpful when running an import process. | | \[10] **Save SSL Settings** | Save ssl settings for future | :::hint{type="info"} **Example**: You have the following intermediate certificates: `intermediate1.pem` and `intermediate2.pem`. You create a CA chain file by combining the intermediate certificates with the root certificate (`root.pem`) with the following command: `cat intermediate1.pem intermediate2.pem root.pem > ca-chain.pem`. The CA chain file is named `ca-chain.pem`. ::: # Edge Remote The Edge Remote endpoint is the location of the Litmus Edge Manager remote service that forms a private secured connection between this Litmus Edge Manager instance and all of its associated Litmus Edge devices. This endpoint can be used for a DNS or an IP address. By default and in most circumstances, the Edge Remote endpoint will be identical to the Litmus Edge Manager instance's IP address/DNS. The only exception is when the Litmus Edge Manager is deployed on Google Kubernetes Engine. In this deployment situation, the IP address of the Litmus Edge Manager and the IP address of the LEM remote service will differ. The IP address of the Litmus Edge Manager remote service will be generated by Kubernetes and should be set as the Edge Remote endpoint accordingly. If a DNS is associated with the IP address received from Kubernetes, then the DNS should likewise also be set as the Edge Remote endpoint accordingly. Setting the DNS this way prevents the need to reactivate Litmus Edge devices when the Litmus Edge Manager IP address changes. Refer to the following actions you can take on Litmus Edge Manager Admin Console's *Domain/SSL* pane. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/sPP9BQBj2l9x9yLhclZUD_image.png" size="80" width="1919" height="163" position="center" caption="Domain/SSL : Edge Remote" showCaption="true"} | **Action** | **Details** | | ----------------------------------- | --------------------------------------------------- | | \[11] **Edit Edge Remote** | Edit the edge remote option | | \[12] **Copy ** | - Edge Remote endpoint | | \[13] **Save Edge Remote endpoint** | You can only save when the DNS/IP address is valid. | [title] Purge Policies [path] Litmus Edge Manager Admin Console/Product Features/Data Lifecycle/ The Purge Policies module allows you to create instance/company purge policies to archive or purge `ARCHIVE` data or `USERDATA` automatically given a certain condition. The Purge Policies module includes the following sections: - **Instance Purge Settings**: Allows you to add `ARCHIVE` or `USERDATA` purge policies for the instance level. You can set up a policy action to purge or archive data and limit the purge by the number of periods, by the project's data size, or by the free-disk-space percentage. - **Companies Purge Settings**: Allows you to add `ARCHIVE` or `USERDATA` purge policies for a company. You can set up a policy action to purge or archive data and limit the purge by the number of periods, by the project's data size, or by the free-disk-space percentage. You can also filter the instance/company purge policies list from this sub-module. # Archiving Needs Additional Disk Space When data is archived, the data is extracted from a Clickhouse Data Server and stored as a `.csv.gz` file. Each `.csv.gz` file is up to ten times the size of the data size displayed in Litmus Edge Manager (The data size that is shown in the *Stats By Periods *section of [Statistics](docId\:SUvgdkwr-7WY9lRvKLBqM) is a compressed size). Before you archive, ensure the Litmus Edge Manager has enough disk space to store all the `.csv.gz` file data that it will archive. Insufficient disk space will prevent the data from being archived. After archiving, review the list of archive files to ensure the archive operation was successful. # Access Purge Policies UI **To access the purge policies UI:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Data Lifecycle**. Data Lifecycle's *Statistics* pane by default appears. 3. From Data Lifecycle's navigation sub-panel, select **Purge Policies**. Data Lifecycle's *Purge Policies* pane appears. Refer to the following actions you can take on the Litmus Edge Manager Admin Console Data Lifecycle's *Purge Policies* pane. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/DEwg40JzVJ1I8b8C7Tq8f_image.png" size="80" width="1920" height="969" position="center" caption="Data Lifecycle: Purge Policies" showCaption="true"} | **Action** | **Details** | | -------------------------------------- | -------------------------------------------------------------------------------------------- | | \[1] **Show filter** / **Hide filter** | Search by *Data Type* and *Policy Action* | | \[2] **Create Instance Purge Policy** | Option availability depends on previous selections. See the Create a Policy section below. | | \[3] **Action menu** | - **Edit: **Option availability depends on previous selections. - **Remove** | | \[4] **Show filter** / **Hide filter** | * Search by *Company Name, Data Type* or *Policy Action* | | \[5] **Create Company Purge Policy** | Option availability depends on previous selections. | | \[6] **Action menu** | - **Edit: **Option availability depends on previous selections. - **Remove ** | # Period Explained Litmus Edge Manager keeps track of disk usage in partitions of months. The tracked disk usage is only for Clickhouse data (hence all archive/purge operations are applicable for only Clickhouse data). The disk usage amount is calculated either from the instance or each individual project. Each month of disk usage is defined as a period. For example, your Litmus Edge Manager has five projects. To calculate disk usage, each project will be categorized as one period for the same month. So Litmus Edge Manager will generate five periods for the same month, each period including one project. As an additional example, three months have passed. For the five projects above, each of them experienced some disk usage in those three months. So you will have 15 additional periods (five projects of disk usage \* 3 months). Periods are also categorized as previous or current. If the current system date is March 2023, then all disk usage by projects during March 2023 are current periods. All periods from February 2023 and before are previous periods. # Create a Policy A policy is only applicable for a previous period. See [Statistics](docId\:SUvgdkwr-7WY9lRvKLBqM). :::hint{type="info"} **Note**: When policy types are considered, disk usage for a current period of the Litmus Edge Manager will be ignored. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/oyF4V_-u8n2E_eQn2jZfr_image.png" size="80" width="570" height="540" caption="Create Policy dialog box" position="center" showCaption="true"} - **Select Company: **Select a company to apply to policy towards. All of the company's projects and the projects' respective periods will be included when creating a policy. This option is only available for *Companies Purge Settings*. - **Select Data Object: ** - `Archive`: Apply the policy toward an existing archive in [Management](docId\:dsJZJ4n3ksgiQlIabM-gY). - `Userdata`: Apply the policy towards existing data. :::hint{type="info"} **Note**: - For Instance Purge Settings, you may only create one policy per Data Object. - For Companies Purge Settings, you may only create one policy per Company-Data Object pairing. ::: - **Policy Action:** - `Archive`: Archive the data if a previous period fails to stay within a policy type limit. You cannot archive an `Archive Data` object. When this policy is selected, archiving a period will also automatically purge the data after successful archiving. - `Purge`: Delete the data if a previous period fails to stay within a policy type limit. - **Policy Type **(See the *More on Policy Types *section below) - **Limit by number of periods: **You cannot select this for an `Archive Data` data object. - **Limit by project's data size** - **Free disk space limit, %** - **Policy Limits Value** - **Limit by number of periods: **At least 1 or more. - **Limit by project's data size: : **At least 1 or more. - **Free disk space limit, %: **As of Litmus Edge Manager 2.10.1, enter a percentage value between 0-50%. Decimal values are allowed. ## More on Policy Types Refer to the *Period Explained* section above to learn more about the definition of *period* in Litmus Edge Manager's Data Lifecycle feature. When a policy is selected for instance purge settings, it will check all existing project's previous periods. When a policy is selected for company purge settings, it will check the selected company's existing project's previous periods. ### Limit by number of periods Data will be archived/purged based on the number of months you enter. **Example 1** You enter 1 and the current date is January 1, 2023. - Litmus Edge Manager checks the age (in months) of every single previous period. So December 2022 would be 1, November 2022 would be 2, and so on. - It compares the period's age against the age you entered earlier (1). If the period's age is equal to or greater than the age you entered earlier (1), then archive/purge. - All data within each previous individual month will be archived/purged starting backwards from December 2022. - When the current date advances to February 1, 2023, the data from January 2023 will be archived/purged. **Example 2** You enter 3 and the current date is January 1, 2023. - Litmus Edge Manager checks the age (in months) of every single previous period. So December 2022 would be 1, November 2022 would be 2, and so on. - It compares the period's age against the age you entered earlier (3). If the period's age is equal to or greater than the age you entered earlier (3), then archive/purge. - All data within each previous individual month will be archived/purged starting backwards from October 2022. - When the current date advances to February 2023, the data from November 2022 will be archived/purged. This means the three-month duration of December 2022-February 2023 is stored in Litmus Edge Manager. ### Limit by project's data size Data will be archived/purged for a previous period if the data size is equal to or greater than the data size you enter. The oldest data is archived/purged first. **Example 1** You enter 1GB and the current date is January 1, 2023. - Litmus Edge Manager checks the data size of every single previous period. - If the single previous period's data size is 1GB or more, it will be archived/purged. - When the current date advances to February 1, 2023, Litmus Edge Manager checks for all the data size for the January 2023 period. All January 2023 periods with a data size of 1GB or more are archived/purged. ### Free disk space limit, % Data will be archived/purged once as long as the free disk-space percentage is below the specified threshold. The oldest data is archived/purged first. **Example 1** You enter 1% and the total disk space size is 100GB. - Once Litmus Edge Manager's free disk space is less than 1GB, it will archive/purge all previous periods. - If Litmus Edge Manager's free disk space is 1GB or more, do nothing. - For purging, all the purge operations of each period will happen concurrently. Therefore, if a purge increases the free disk space percentage above the 1GB threshold, it will not stop the purge for the remaining periods. **Example 2** You enter 50% and the total disk space size is 100GB. - Once Litmus Edge Manager's free disk space is less than 50GB, it will archive/purge all previous periods. - If Litmus Edge Manager's free disk space is 50GB or more, do nothing. - For purging, all the purge operations of each period will happen concurrently. Therefore, if a purge increases the free disk space percentage above the 50GB threshold, it will not stop the purge for the remaining periods. [title] Node-Locked Licenses [path] Litmus Edge Manager Admin Console/Product Features/Edge Devices/ You can view and export a comprehensive summary of the usage of all Node-locked licenses for all companies and projects. # Access Node-Locked Licenses UI **To access the node-locked licenses UI:** 1. Log in to Litmus Edge Manager Admin Console. 2. From the Navigational panel, select **Edge Devices**. The *Edge Devices *pane appears. 3. Click **Node-locked Licenses **from the side menu. The *Node-locked Licenses *pane appears. Refer to the following actions you can take from this page: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/brf3njQH9iEwyxK8vGasS_image.png" size="80" width="1277" height="747" position="center" caption="Node-locked Licenses pane" showCaption="true"} | **Action** | **Details** | | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Node-locked License Usage Statistics** | Displays comprehensive details about the usage of all node-locked licenses, including which licenses are currently active and their associated projects or companies. | | \[2] **Filter** | Allows users to sort and narrow down the list of node-locked licenses based on specific criteria such as license status or network names. | | \[3] [Generate a Report](docId\:NayEcoyMir18JHrrDQCRl) | Enables the creation of a custom report on node-locked licenses by searching with parameters like Network Name, Subnet, or Status. | | \[4] **Refresh List** | Updates the displayed list of node-locked licenses to ensure it reflects the most current information available in the system. | [title] [path] Litmus Edge Manager Admin Console/ [title] Edge Remote Networks [path] Litmus Edge Manager Admin Console/Product Features/Edge Devices/ Use the *Edge Remote* module to remotely connect your edge devices to default or networks that you add. You can view additional information about the network's status, bandwidth, and peers. You can also set the Maximum Transmission Unit (MTU) of the network interface. Access the following tabs in Edge Remote Networks: - **Networks**: The Edge Remote Networks pane includes: - **Network**: Contains a list of Edge Remote networks including a default network. You can add, modify, and remove a network and set a network as default. :::hint{type="info" indent="3"} Creating and setting a new default network does not affect existing projects. It applies only to newly created or empty projects. ::: :::Paragraph{listStyleType="disc" listStart="2" indent="2"} **Projects**: Contains a list of companies and projects that access the networks. You can change the network for a company or project. ::: - **Statistics**: The Edge Remote Network Statistics pane includes: - **Network**: View the Edge remote network status, number of networks, number of peers, and percentage of networks online. - **Networks Bandwidth**: View the amount of data transmitted for the connected networks in Mbps. - **Network Peers**: View the connected peers which are connected edge devices in another project. - **Settings (version 2.11.0 and later)**: The Edge Remote Settings pane includes: - **MTU**: Configure the Maximum Transmission Unit (MTU) value of the network interface. # Access Edge Remote Networks UI **To access the edge software networks UI:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation pane, select **Edge Devices**. The *Edge Devices *pane appears by default. 3. From Edge Device's navigation sub-pane, select **Edge Remote Networks**. Edge Device's *Edge Remote Networks* pane appears. The example below applies to Litmus Edge Manager version 2.15.0 and later. ![](https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/sWbcbawfoGord0D5geqqn_image.png "Edge Remote Networks") # Network From the Edge Remote Networks pane, you can add and manage remote networks and view the company and project for connected edge devices. The Edge Remote Networks pane includes two sections. The *Network *section contains a list of Edge Remote networks. You can add, modify, and remove a network, set a network as default, and filter the networks list. The Networks list displays the network name, the network's subnet mask, the capacity of activated devices for the network (Litmus Edge Manager 2.15.0 and later), the type of subnet, the port, which network is default and its state, and an action list where you can perform tasks. The *Projects* section contains a list of companies and their associated projects that have access to the networks. These are added automatically to the default network when you connect an edge device to a project in Litmus Edge Manager. You can view the projects without a subnet mask and filter the project list. If you have added multiple networks, you can change the network for a company or project listed here. The Projects list displays the network name, the network's subnet mask, company and project name of the connected edge device, the number of peers associated with the network, and an action list where you can perform tasks. ![](https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/5WdAryadQZgkIT6bYcDFK_image.png "The Network tab") | **Action** | **Details** | | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **View Network Name** | ****[Add/View a Remote Network](docId\:uektCkVQ4gjdu0CerwIMP) | | \[2] **Peers Qty / Max Number** | Available for Litmus Edge Manager version 2.15.0 and later. Review the capacity of activated devices for the work. The following information displays:
* **Peers Qty**: The current number of activated devices for the network. * **Max Number**: The maximum number of activated devices allowed. * **Percentage**: The capacity of activated devices remaining for the network represented as a percentage value. For example, if the capacity is five activated devices and five devices are activated, the percentage displays 0% capacity remaining. | | \[3] **Show filter** / **Hide filter** | - Search by *Network Name*, *Subnet*, or *Listen Port* | | \[4] **Refresh** | Refreshes network list | | \[5] **Add a Network** | [Add/View a Remote Network](docId\:uektCkVQ4gjdu0CerwIMP) | | \[6] **Action menu** | * **Edit** * **Set Default: **The network assigned to the company and projects does not change when you set a new default network. Any new edge devices that you connect are automatically assigned to the new default network. * **Remove: **You cannot remove a default network. Set a different network as default if you want to remove the network. | | \[7]** Show filter** / **Hide filter** | Search by *Network Name*, *Subnet*, *Company/Project*, *Peers Qty* | | \[8] **Refresh** | Refreshes project network list | | \[9] **Show Projects without subnet** / **Show all projects** | Displays all projects without the subnet. | | \[10] **Action menu** | - **Change Network: **You must have at least two networks added to the Networks list. | # Statistics From the *Edge Remote Network Statistics* pane, you can view information about the remote networks for edge devices. The Edge Remote Network Statistics pane includes three sections. The *Network* section contains a pane indicating network status, the number of networks, the number of peers associated with the edge devices, and the percentage of networks online. The*** **Networks Bandwidth** ***section contains a chart of the bandwidth over time for the connected networks in Mbps. You can hover over the chart to view the bandwidth for a particular point in time. The *Networks Peers* section contains a list of connected peers that are connected edge devices in another project. You can view the default network for any connected peer. Click a network name to view more details. # Settings :::hint{type="info"} **Note**: This feature below is for Litmus Edge Manager version 2.11.0 and later. ::: From the *Settings* pane in the *Edge Remote* module, you can set and configure the value of the Maximum Transmission Unit (MTU) of the network interface. The MTU is the maximum size of a data packet that can be transmitted over a network interface without fragmentation. ![](https://app.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/WaA2d58V0X0E1uM8cGoDS_image.png "Edge Remote Networks: Settings") This value configures the Litmus Edge Manager (LEM)'s connection to a Litmus Edge (LE) device and can be used to address potential network issues between LEM and an LE. The default value is 1280 bytes and can be set to the following: - For Litmus Edge Manager version 2.11.0 to 2.14.0, between 1280 bytes to 1500 bytes. - For Litmus Edge Data Manager version 2.16.0 and later, between 576 bytes and 1500 bytes. [title] Set Up a Litmus Edge API Token for an Application Release [path] Litmus Edge Manager User UI/Product Features/Marketplace: Catalogs and Applications/Application Releases/Add a Draft Application Release/ When configuring an application release for deployment to a Litmus Edge instance, you can include an API token for the Docker container of the release. Follow the steps below to create and apply the API token. # Before You Begin - Ensure you know how to create a draft application release. See [Create a Draft Application Release](docId\:pujQCF4jL0dUe8XjHsjmZ) for details. # Step 1: Create The `EGDE_API_TOKEN` Variable 1. Create a variable named `EDGE_API_TOKEN` for the application release. 2. Set the variable value and adjust any other parameters as needed. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/9cdJo-4RfbIB1NQTR60H3_image.png" size="80" width="1168" height="547" caption="EDGE_API_TOKEN" position="center" showCaption="true"} # Step 2: Complete and Submit Application Release 1. Follow the instructions from *Step 3-Step 5* in [Add a Draft Application Release](docId\:pujQCF4jL0dUe8XjHsjmZ) to create a draft application release. 2. Submit the draft release when ready. # Step 3: Launch the Application from Litmus Edge Manager 1. To ensure the `EDGE_API_TOKEN` is properly set, launch the application from the **Litmus Edge Manager (LEM)**. 2. LEM will automatically create an API token named `MPC-APP` in Litmus Edge during this process if it does not already exist. 3. The `MPC-APP` token value will be passed into the `EDGE_API_TOKEN` environment variable. :::hint{type="info"} **Important Notes:** - If the application is launched directly from Litmus Edge, the environment variable will not include the API token. - If the application is not working as expected, use ***Step 4 ***& ***Step 5*** to verify that the API token is created and passed correctly. ::: # (Optional) Step 4: Confirm API Token **To confirm an API token with the name **`MPC-APP`** exists on your litmus edge:** 1. Log in to Litmus Edge. 2. From the Navigation panel, navigate to **System **>** Tokens**. The *NATS Proxy *pane appears. 3. Ensure the `MPC-APP` token is created and appears in the list. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/dptzQa8b53RHHiVaFksQp_image.png" size="80" width="1713" height="846" caption="System > Tokens" position="center" showCaption="true"} # (Optional) Step 5: Verify Passed API Token Assignment to Docker Container **To ensure that the API Token has been passed to the Docker Container from Litmus Edge:** 1. Log in to Litmus Edge. 2. From the Navigation panel, select **Applications**. The *Dashboard *pane appears. 3. Click **Containers**. The *Containers *pane appears. 4. Click **Inspect **to view the container details. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/i4R-aT6xb-nd0PoVT6BaE_2023-07-2111-11-45.png "Inspect button location") 5. Scroll down to the **Config **section under **Env **and check that `EDGE_API_TOKEN` matches the `MPC-APP` token from Step 3. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/-nl3uwYRyZbHpmacyPxo6_image.png" size="80" width="1713" height="846" position="center" caption="Config: Env" showCaption="true"} [title] Application Releases [path] Litmus Edge Manager User UI/Product Features/Marketplace: Catalogs and Applications/ After selecting an application from a catalog, you can add/view/customize version releases for the application. Every Docker application will contain at least one Docker application release. A Docker application release can be created and configured under one of the Application tabs: *Containers*, *Containers Advanced* or *Compose*. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/vONg6A5LzN3ykncqefIsk_image.png" size="80" width="955" height="352" caption="Containers, Containers Advanced, Compose" position="center" showCaption="true"} A Docker application release is a combination of optional variables and at least one component (*Containers*/*Containers Advanced*) or a compose configuration file (*Compose*). The Docker application release (once submitted) will be used during an application deployment operation (See the *Step 2: Application Settings* section of [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw)) to Litmus Edge instances. The optional variables will later be presented as configurable parameters during deployment. The component or the compose configuration file sets up a configuration to extract at least one Docker image from a Docker repository to execute the Docker image's respective Docker container. This allows the Docker application release to package multiple Docker images (and the respective Docker containers) and deliver them to Litmus Edge instances concurrently. Although it is possible to submit a Docker application release without at least one component (*Containers*/*Containers Advanced*) or a compose configuration file (*Compose*), the Docker application release cannot be later deployed to a Litmus Edge instance. A Docker application release is always in one of two states, `RELEASED` (submitted) or `DRAFT`. When a Docker application release is in a `RELEASED` state, it cannot be further modified. Likewise, when it is in `DRAFT`, it can be modified. :::hint{type="warning"} **Important: **When a Docker application release is in `DRAFT` state, it can not be deployed to a Litmus Edge instance. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/jK1DcZTxllz5P-gnfvNo0_image.png" size="80" width="1920" height="914" position="center" caption="Catalog Applications: Containers/Containers Advanced/Compose" showCaption="true"} # Next Steps - [Add a Draft Application Release](docId\:pujQCF4jL0dUe8XjHsjmZ) - [Manage Application Releases](docId\:FoZMtmXkxEI6Y-gPZAEvg) [title] Set Up Docker Container Configurations for an Application Release [path] Litmus Edge Manager User UI/Product Features/Marketplace: Catalogs and Applications/Application Releases/Add a Draft Application Release/ An application release must contain at least one component (*Containers*/*Containers Advanced*) or a compose configuration file (*Compose*). Although it is possible to submit a Docker application release without at least one component (*Containers*/*Containers Advanced*) or a compose configuration file (*Compose*), the Docker application release cannot be later deployed to a Litmus Edge instance. The component or the compose configuration file sets up a configuration to extract at least one Docker image from a Docker repository to execute the Docker image's respective Docker container. This allows the Docker application release to package multiple Docker images (and the respective Docker containers) and deliver them to Litmus Edge instances concurrently. It is these Docker images from the component/compose configuration file that will be later deployed as Docker images to Litmus Edge instances during [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw). # Option 1 Containers: Set Up a Component See the following on how to add/manage components for the *Containers* tab. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/2m0b7gZE5lt1AX7PIF8g5_2023-07-2111-13-41.png "Containers: Components ") | **Action** | **Details** | | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Show filter **/ **Hide filter** | Search by *Name*, *Image*. | | \[2] **Add Component** | You can add multiple components. You can't add variables for a submitted application release. | | \[3] **Action menu** | - **Edit: **You can't edit components for a submitted application release. - **Remove: **You can't delete components for a submitted application release. | ## More on Add Component When adding a new component, a Docker image must be extracted from a Docker registry. The other available customizations enable additional configurations when executing the Docker container from the extracted Docker image. Furthermore, when customizing the Docker image configurations, it is also possible to use the variables created from [Set Up Variables for an Application Release](docId\:HF5YyWh3bwhFi6m2jKxHt) as values. The syntax for referring to these variables is `${VARIABLE_NAME}` where `VARIABLE_NAME` is the name of the variable being used. ### Step 1: Set Up Common Parameters In this section, you will set up the initial configuration needed for a Docker image’s respective Docker container. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/u9TZBjFfOAr6rYUbdYG0v_image.png" size="80" width="1550" height="658" position="center" caption="Add Component: Common Parameters" showCaption="true"} - **Name**: Assign a name for Docker container. See [Assign name](https://docs.Docker.com/engine/reference/commandline/run/#assign-name-and-allocate-pseudo-tty---name--it) for details. - **Repository**: The available registry provider of the Docker image. See [Registry Management](https://app.archbee.com/docs/VAKj8ZK5Bi9ApnYcgeYQr/M6yzedYRAwwYDnLDtOQlZ) and [Docker Registry](https://docs.Docker.com/registry/) for details. - **Image: **The Docker image registry location for a Docker pull command. See [Pull From a Different Registry](https://docs.docker.com/engine/reference/commandline/pull/#pull-from-a-different-registry) for details. The image registry location must be both a valid registry location and accessible by Litmus Edge instances. - **Restart**: The restart policy for the equivalent Docker container. See [Use a Restart Policy](https://docs.docker.com/config/containers/start-containers-automatically/#use-a-restart-policy) for details. - **Network Mode**: The network settings for the equivalent Docker container. See [Network Settings](https://docs.docker.com/engine/reference/run/#network-settings) for details. - **Enable TTY**: See `--tty` or `-t` of [Options](https://docs.docker.com/engine/reference/commandline/run/#options) and [Allocate Pseudo-TTY](https://docs.docker.com/engine/reference/commandline/run/#name) for details. - **Open STDIN**: See the `--interactive` or `-i` option of [Options](https://docs.docker.com/engine/reference/commandline/run/#options) and [Allocate Pseudo-TTY](https://docs.docker.com/engine/reference/commandline/run/#name) for details. - **Privileged**: See [Full Container Capabilities](https://docs.docker.com/engine/reference/commandline/run/#privileged) for details. - **Command**: The command-line arguments used by the Docker container’s application when it executes. ### Step 2: Set Up Environment In this section, you can set up the environment variables that the Docker container will use during its operation. See [Environment Variables](https://docs.docker.com/engine/reference/run/#env-environment-variables) for details. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/U8mYfLW4ezm_6usD-GHNH_image.png" size="80" width="1553" height="451" position="center" caption="Add Component: Environment" showCaption="true"} ### Step 3: Set Up Labels In this section you can set up metadata to the Docker container. See [Set Metadata on Container](https://docs.Docker.com/engine/reference/commandline/run/#set-metadata-on-container--l---label---label-file) for details. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/_nzEkg2LOmnb6sIyxqX-m_image.png" size="80" width="1565" height="457" position="center" caption="Add Component: Labels" showCaption="true"} ### Step 4: Set Up Ports In this section, you can set up the port management for the Docker container. See [Ports](https://docs.docker.com/network/#published-ports) for details. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/E-l71hY1sGW0FfZwySYgO_image.png" size="80" width="1556" height="463" position="center" caption="Add Component: Ports" showCaption="true"} ### Step 5: Set Up Volumes In this section, you can set up the data persistence mechanism for the Docker container. See [Use volumes](https://docs.docker.com/storage/volumes/) or [Use bind mounts](https://docs.docker.com/storage/bind-mounts/) for details. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/o8YsMDDqj7Hl5Pbi5Cyqj_image.png" size="80" width="1557" height="445" position="center" caption="Add Component: Volumes" showCaption="true"} # Option 2 Containers Advanced: Set Up a Component This option is an upgraded version of *Option 1 Containers: Set Up a Component. *See the following on how to add/manage components for the *Containers Advanced* tab. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/FYp43y4JVR4xbkc8LpIoQ_image.png" size="80" width="1920" height="914" position="center" caption="Containers Advanced: Components " showCaption="true"} | **Action** | **Details** | | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Show filter **/ **Hide filter** | Search by *Name*, *Image*. | | \[2] **Add Component** | You can add multiple components. You can't add variables for a submitted application release. | | \[3] **Action menu** | - **Edit: **You can't edit components for a submitted application release. - **Remove: **You can't delete components for a submitted application release. | ## More on Add Component In *Option 1 Containers: Set Up a Component*, there are five steps where you may enter details for a pre-determined set of basic Docker parameters. The limitation of the previous option is that it is not possible to access and configure the remaining more advanced Docker parameters. When adding a new component, this second option offers a `.json` configuration form to access and configure the remaining advanced Docker parameters. The form will be used to request a Docker image from a selected Docker registry. ### Step 1: Set Up Common Parameters The first step is a simplified version of the *Step 1: Set Up Common Parameters* section from the previous option. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3VDDmrWGOCdsVX4fFaEak_image.png" size="80" width="1460" height="362" position="center" caption="Add Component: Common Parameters" showCaption="true"} - **Name**: Assign a name for Docker container. [Assign name](https://docs.Docker.com/engine/reference/commandline/run/#assign-name-and-allocate-pseudo-tty---name--it) for details. - **Repository**: The available registry provider of the Docker image. See [Registry Management](docId\:M6yzedYRAwwYDnLDtOQlZ) and [Docker Registry](https://docs.docker.com/registry/) for details. ### Step 2: Insert Container Create Configuration `.json` File The second step allows you to create a Docker container by entering file contents for a Docker container configuration `.json` file. See [Create a container](https://docs.docker.com/engine/api/v1.40/#tag/Container/operation/ContainerCreate) for details. Furthermore, when customizing the `.json` file, it is also possible to use the variables created from [Set Up Variables for an Application Release](docId\:HF5YyWh3bwhFi6m2jKxHt) as values. The syntax for referring to these variables is `${VARIABLE_NAME}` where `VARIABLE_NAME` is the name of the variable being used. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/irDpL9L2d3pc3xyLBs2gG_image.png" size="80" width="1462" height="684" position="center" caption="Add Component: Config" showCaption="true"} | **Action** | **Details** | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | \[1] **Import Component Config** | Load the component configuration from an external source. | | \[2] **Copy Config Content** | Duplicate the current configuration content to the clipboard. | | \[3] **Paste Config Content** | Insert the previously copied configuration content into the designated area. | | \[4] **Clear Config Content** | Remove all existing configuration content from the input field. | | \[5] **Link to API specifications for **[Creating a container](#) | Access documentation detailing the API procedures for container creation. | | \[6] **Enter Config Content** | Input the configuration settings manually into the designated field. | # Option 3 Compose: Set up a Compose This option is an even more upgraded version of the previous two options in the form of an alternative Compose subsection. Rather than creating a component one by one like the previous two options, you are able to set up multiple components all at once by entering a YAML Compose file to set up a multi-container application configuration. See [Compose specifications](https://docs.docker.com/compose/compose-file/) for details. Furthermore, when customizing the YAML file, it is also possible to use the variables created from [Set Up Variables for an Application Release](docId\:HF5YyWh3bwhFi6m2jKxHt) as values. The syntax for referring to these variables is `${VARIABLE_NAME}` where `VARIABLE_NAME` is the name of the variable being used. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/WhJlUYeb3WXFmKg4-hqXe_image.png" size="80" width="1562" height="763" position="center" caption="Catalog Applications: Compose" showCaption="true"} | **Action** | **Details** | | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | \[1] **Import Compose File** | Allows users to upload a Compose file for processing. | | \[2] **Copy Compose File** | Facilitates the duplication of a selected Compose file. | | \[3] **Paste Compose File** | Enables the insertion of a copied Compose file into the designated location. | | \[4] **Clear Compose File** | Removes all content from the current Compose file. | | \[5] **Link to Compose File format in **[Compose specifications](https://docs.docker.com/compose/compose-file/) | Provides access to the official specifications for Compose file formatting. | | \[6] **Compose File Contents** | Displays the data and configuration included within the selected Compose file. | | \[7] **View Supported Compose Objects** | Lists all objects that are compatible with the Compose file format. | ## Supported Compose Objects When you click **Supported Compose Objects, **a list of all the supported objects displays from the right. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ag1e26IfOOEEq_KxIIEwd_image.png" size="50" width="413" height="732" caption=" Supported Compose Objects" position="center" showCaption="true"} When you attempt to **Save** a YAML Compose file with unsupported compose objects, an error such as the following appears. It will indicate all the invalid fields. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/mqvYl5xzLG2QXaTuh3ELM_image.png" size="80" width="777" height="322" position="center" caption="Invalid Data: unsupported Compose Objects" showCaption="true"} [title] Manage Application Releases [path] Litmus Edge Manager User UI/Product Features/Marketplace: Catalogs and Applications/Application Releases/ A Docker application release is always in one of two states, `RELEASED` (submitted) or `DRAFT`. When a Docker application release is in `RELEASED` state, it cannot be further modified. When it is in `DRAFT`, it can be modified. :::hint{type="warning"} **Important: **When a docker application release is in `DRAFT` state it can't be deployed to a Litmus Edge instance. ::: See the following on how to manage Docker application releases. The following user interface is identical for *Containers*, *Containers Advanced*, and *Compose*. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/aet8lY4FRC5TADGHWpqZ7_2023-07-2111-15-43.png "Containers/Containers Advanced/Compose") | **Action** | **Details** | | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \[1] **Clone release** | Search by *Name*, *Image*. | | \[2] **Show release details ** | Modifications cannot be made when viewing a submitted release. | | \[3] **Remove release ** | - Removing a release cannot be undone. | | \[4] **View more details about this release** | See [Set Up Variables for an Application Release](docId\:HF5YyWh3bwhFi6m2jKxHt) and [Set Up Docker Container Configurations for an Application Release](docId\:mebpl6tcgzj9NS2Cmk5cQ) for details. | | \[5] **Edit release ** | Once a release has been submitted, you can no longer modify it. You can clone the submitted release, and then modify the clone (while it is still in the Draft status).
- **Edit Release** - **Submit Release** | # Next Steps After a Draft Application Release has been submitted (`RELEASED`), it can then be deployed to Litmus Edge instances. See [Deploy an Application to Edge Devices](docId\:DruoOcegNxCGi-D_5azZw) for details. [title] Step 2: Create Secondary Catalog [path] How-To Guides/Litmus Edge Manager User UI Guides/Deploy Edge Applications to Multiple Sites Using Marketplace Catalog Sync/ After creating a catalog of applications and release versions for the primary marketplace, you need to create a *Secondary *marketplace catalog in Litmus Edge Manager (LEM) located in Japan. :::hint{type="info"} **Note: **You can only create new Secondary Catalogs. You cannot edit an existing catalog to convert it to a secondary catalog. ::: **To create a secondary marketplace catalog:** 1. Go to *Litmus Edge Manager User UI *and select the appropriate company and project. Then, navigate to **Features **>** Marketplace. ** The *Marketplace Catalog* opens in a new browser window. 2. Click **Add Catalog.** The *Create Catalog* dialog box appears. - Enter a **name **and optionally enter a **description**. - Select the **Synchronize **checkbox. Then, from the *Select Role* drop-down list, select **Secondary**. - Click **Save**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/JBFTBQnk4SG_i_zY08usW_image.png" size="70" width="627" height="297" position="center" caption="Create Catalog dialog box" showCaption="true"} The Secondary marketplace catalog will include all the applications from the Primary catalog after a secure connection is established. **Next: **[Step 3: Establish Secure Connection Between Primary and Secondary Catalog](docId\:s8JGesiGUpFPEHtDB_cfv) [title] Events [path] Litmus Edge Manager Admin Console/Product Features/ You can view general and project-specific system events and asynchronous events. ## View Events View general and instance system events in **Events** in Admin Console. Here you can sort events by: - Time - Level, for example, Info or Error. - Type, for example, grafana, git-sync, or report-stats - Company or project - User ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/KLtPp-bT4ssJXaiRQKVij_image.png" size="80" width="1510" height="983" position="flex-start" showCaption="false" indent="1"} [title] Registry Management [path] Litmus Edge Manager User UI/Product Features/Marketplace: Catalogs and Applications/ Registry management enables you to view, add, and remove registry providers. These registry providers will be the source of where Docker images of marketplace catalog applications can be pulled when deploying to Litmus Edge instances. Docker requires you to connect to a [secure registry](https://docs.docker.com/registry/deploying/#running-a-domain-registry). You can find more information about how to connect to an [insecure registry](https://docs.docker.com/registry/insecure/). The default registries available are: - [Elastic Docker Registry](https://www.docker.elastic.co) - [Microsoft Docker Container Registry ](https://mcr.microsoft.com) - [Public Docker Hub](https://hub.docker.com) ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/biJ85b7LRk2Sn5dB_SRIr_2023-07-2111-16-45.png "Catalog Applications: Registry") | **Action** | **Details** | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | \[1] **Return to Applications** | [Marketplace: Catalogs and Applications](docId\:gqoGt_Szm8rz9UdPhl2NL) | | \[2] **Add new repository ** | Refer to the following parameters to configure for each registry.
AWS ECR
* **Name** * **Registry Description** (Optional) * **AWS Region** (Optional) * **AWS Key ID** * **AWS Secret Key**
Azure Container Registry
* **Name** * **Registry Description** (Optional) * **Service principal name** * **Service subscription identifier** * **Client ID ** * **Client Secret ** * **Resource Group** * **Registry Name** * **Address**: Enter the location of the registry.
Docker Registry
* **Name** * **Registry Description** (Optional) * **Docker Login Server**: Enter `https://index.docker.io/v1` . * **Docker Login User **(Optional) * **Docker Login Password** (Optional) * **Docker CA Certificate** (Optional): Paste a CA Certificate in the **Docker CA Certificate **field. If Litmus Edge is already connected to Litmus Edge Manager, the CA Certificate used for that connection is applied. * **Docker Skip TLS Verification** (Optional) Select the check box to bypass the TLS security.
Google Container Registry
* **Name** * **Google container registry address** * **Repository Description** (Optional) * **JSON key file**: Browse to add a key file. | | \[3] **Remove release ** | Delete the occurrence of release. | | \[4] **Delete repository** | Remove the repository permanently. | [title] DNS [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/Network/ :::hint{type="info"} **Note**: The DNS feature is available for Litmus Edge Manager version 2.10.1 and later. ::: You can configure the DNS settings by navigating to **Settings** > **Network** and clicking the **DNS** tab. This feature enables you to configure Litmus Edge Manager to connect to specific DNS Servers. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Sxmgg4glQaGquGAuOYFsU_image.png "DNS Tab") # Update DNS Settings You can add/delete the DNS server(s) the Litmus Edge Manager will connect to. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CJKDfotTIrFgZmhBL73y7_image.png" size="80" width="703" height="393" caption="DNS Settings" position="center" showCaption="true"} [title] Alerts [path] Litmus Edge Manager Admin Console/Product Features/ The **Alerts** page lets you configure and monitor alert activity across your instance. An alert consists of a trigger and an action. A trigger monitors an event or metric and fires when defined conditions are met. An action sends a notification, such as an email or webhook call, when a trigger fires. Each time a trigger fires, the system creates an incident that you can track and resolve. The Alerts page contains three tabs: - **Incidents** A log of all triggered incidents across the instance. Filter, sort, and resolve incidents from this tab. - **Triggers** Configure the events and metrics that fire alerts and send notifications. - **Notification Settings** Configure the actions that triggers use to send notifications. [title] Step 6: (Optional) Update an Application Version [path] How-To Guides/Litmus Edge Manager User UI Guides/Deploy Edge Applications to Multiple Sites Using Marketplace Catalog Sync/ You can update an application version in the Primary marketplace catalog and initiate a sync from the Secondary marketplace catalog to pull the new changes. # Before You Begin - Make sure to finish *Steps 1 - Step 5 *of [Deploy Edge Applications to Multiple Sites Using Marketplace Catalog Sync](docId\:Z8R_5mVU1pezFXVSeNhQu) before proceeding. # Step 6a: Add New Application Release Version in Primary Catalog **To add a new application release version in the primary catalog:** 1. Go to the *Primary* marketplace catalog you created in [Step 1: Create Primary Catalog With List of Applications](docId\:qBOZmPgvAQv8-_JM5vYv_) and select *Analytics* application to add a new release version. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/HqO0-MmSUO3Pvmcq26X97_image.png "Primary marketplace catalog pane") 2. Click the **+** icon to open the *Add Release *dialog box. - Enter a suitable **name** for the release. - Enter a **description **for the release version. - Enter a **readme **for the release version. - Click **Save**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/kNACPo32IXVUD6Fl8Y55O_image.png" size="80" width="713" height="347" position="center" caption="Add Release dialog box" showCaption="true"} 3. You can add launch variables or docker container configurations to the draft application release. See *Step 3-Step 5* in [Add a Draft Application Release](docId\:pujQCF4jL0dUe8XjHsjmZ). :::hint{type="info"} **Note: **A Docker application release is always in one of two states: `RELEASED` (submitted) or `DRAFT`. When a Docker application release is in a `RELEASED` state, it cannot be further modified. Likewise, when it is in `DRAFT`, it can be modified. ::: In this guide and in real-world settings, it is recommended that the secondary site always syncs to the draft application release to allow for further modifications specific to their site needs. # Step 6b: Synchronize the Secondary Catalog to the Primary Catalog Once the primary site (Canada) uploads the new version of the application into the Primary Catalog, the secondary site (Japan) manually initiates a sync with the primary catalog to pull the new application version. **To synchronize the secondary catalog with the primary catalog using the new application release version:** 1. From the secondary marketplace catalog's *Synchronization* page, navigate to the **Synchronization: Secondary Catalog **pane. 2. Click **Sync **to pull the new version updates in the catalog. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/BCZ6ACrG-HdZg3yXU8rfC_image.png "Synchronization page") :::hint{type="info"} **Note:** There is no need for approval of a primary catalog sync request this time. A secure connection has been established using a bootstrap file in [Step 3: Establish Secure Connection Between Primary and Secondary Catalog](docId\:s8JGesiGUpFPEHtDB_cfv). ::: To verify if the application(s) have received the new release version, go to the **Applications **pane in the *Secondary *marketplace catalog and confirm the release update. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/X9doG39HYGY0VEdTprxxG_image.png "Secondary marketplace catalog: Applications pane") :::hint{type="info"} **Note: **To make changes to the pulled release version before deploying it to the edge device, see [Manage Application Releases](docId\:FoZMtmXkxEI6Y-gPZAEvg). ::: [title] Step 4: Synchronize Secondary Catalog to Primary Catalog [path] How-To Guides/Litmus Edge Manager User UI Guides/Deploy Edge Applications to Multiple Sites Using Marketplace Catalog Sync/ You will now have to synchronize the secondary catalog to the primary catalog. **To synchronize the secondary marketplace and primary marketplace catalog:** 1. Navigate to the secondary catalog's* Synchronization: Secondary Catalog* pane, and click **Sync**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/o-pfB3V_EW1gpWn2G2Uk7_image.png " Synchronization: Secondary Catalog pane") 2. Click **Applications **to verify the successful synchronization. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/x2avJUlkZKM1k_LV2ptgm_image.png "Applications pane in Secondary Catalog") The secondary catalog in Japan now has the same applications, application releases, and registries as the primary catalog at headquarters. **Next: **[Step 5: Deploy an Application from Secondary Catalog to Edge Devices](docId\:RHJyEcJ3Pt9WzLBsSpTMY) [title] Admin Console Licenses [path] Litmus Edge Manager Admin Console/Product Features/Admin Console Settings/ The Licenses module provides information for the available licenses and features related to your plan. For more detailed information on licenses, see [Site and Node-Locked License Overview for Litmus Edge Manager](docId\:Jvibd0MBSj97ZcPDfhab9). You have the following options for adding a license: - To add/upgrade a Node-locked license (online or offline), see the sections below. - To add a Site license (offline only), see [License Server Management](docId:5U_hNNsaVs--E5HQJEQ0O). Contact your Litmus representative to request a license key. The License pane has three sections: - **License Settings**: Switch between using a Node-locked or a Site license for Litmus Edge Manager. - **Available Licenses:** View the applied licenses for Litmus Edge Manager. - **Online License Activation and Upgrade License Online**: Activate (add) or upgrade a license if the Litmus Edge Manager is connected to the internet. - **Offline License Activation and Upgrade License Offline**: Activate (add) or upgrade a license if the Litmus Edge Manager is not connected to the internet. - **Features***:* View the enabled features associated with your applied licenses. :::hint{type="danger"} **Warning: **Before activating the license, ensure all hardware / VM configuration steps that can modify the Media Access Control (MAC) address (add/replace a Network Interface Controller (NIC) card) are finalized. The license Host ID depends on the MAC address for the device. The MAC address identifies the devices on a network. Changing the MAC address will invalidate the license. ::: # License Settings A Litmus Edge Manager (LEM) license can be either *Node-locked* or *Site*. A *Node-locked* license is one that's locked onto the LEM to enable the instance to be used at anytime without a connection to the license server. A *Site* license requires a reachable connection to a licensing server. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/QsLPTejTICFnzxPvtEje2_image.png "License Settings") \[1]** Select License Setting** \[2] **Save License Setting** # Available Licenses: Viewing, Adding, and Upgrading Node-locked Licenses :::hint{type="info"} **Note: **The Available Licenses section: - Is only visible when a Node-locked license is selected starting with LEM 2.10.1. It is unavailable when a Site license is selected. - Includes the Add License and Upgrade core license features starting with LEM 2.11.0. - Includes an option to delete an existing license starting with LEM 2.14.0. Kubernetes vendor deployment methods, such as GKE and AKS, only support site-based licensing. ::: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/MkobTXF7iEQFE49qk_wQP_image.png "Further license management options") \[3] **Show Filter** / **Hide Filter: **Search by *License* \[4] **Refresh Available Licenses** \[5] **Upgrade core license** \[6] **Delete License**: Only available for Litmus Edge Manager version 2.14.0 and later. You can add (activate) a new or upgrade an existing Litmus Edge Manager Node-locked license. Contact your Litmus representative to request a license key. You can activate your Node-locked license either online or offline. You can add a *Core* or an *Add-on* Node-locked license. While multiple Add-on Node-locked licenses can be added as needed, only one Core license can exist. :::hint{type="warning"} **Important:** Any license added (activated) /upgraded for a Litmus Edge Manager is bound to its MAC address. In case the Litmus Edge Manager has to be reinstalled, assign the same MAC address again to be able to reuse all licenses. ::: ## Activate or Upgrade a Node-Locked License Online Online activation allows you to add (activate) /upgrade a Litmus Edge Manager Node-locked license directly with the Litmus Licensing system. The user interface below is identical to *Upgrade License Online*. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/K93x4ohBTuwdWBfobLxq__image.png" size="80" width="1891" height="385" caption="Online License Activation" position="flex-start" darkWidth="1891" darkHeight="385" showCaption="true"} **To add(activate)/upgrade a license online**: 1. Ensure the Litmus Edge Manager establishes a connection with the internet. 2. In the **Activation Key** field, enter the Litmus Edge Manager Node-locked license key you received from the Litmus Customer Success Team*. *The key has the following structure: `<4 digits>-<4 digits>-<4 digits>-<4 digits>` 3. Click **Submit**. After a successful add/upgrade, the license will be loaded and will be displayed in the *Available Licenses* and *Features* section respectively. ## Activate or Upgrade a Node-Locked License Offline Offline activation allows you to add(activate)/upgrade a Litmus Edge Manager Node-locked license if enterprise cybersecurity rules do not allow for direct access with the Litmus Licensing system through the internet. The user interface below is identical to *Upgrade License Offline*. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Hs8XicWJvVEA-QpdQw1yy_image.png" size="80" width="1920" height="937" caption="Offline License Activation" position="flex-start" darkWidth="1920" darkHeight="937" showCaption="true"} ### Before You Begin - Make sure you have access to a web browser that is connected to the internet to complete this activation. - If your web browser is on a separate computer, use a text file to copy the Host ID, Activation URL and Offline Response. ### Step 1: Obtain Offline Activation Request **From the *****Offline License Activation / Upgrade License offline***** section:** 1. Enter the Node-locked license key in the **Activation Key** field. 2. Click **Generate request**. The activation request appears in the *Offline Activation Request* field. 3. Next to the* Offline Activation Request* field, Click the **Copy activation request** icon. The activation request is copied to your clipboard. 4. Click **Open License Portal**. The *Licensing Portal* opens in a new tab. ### Step 2: Obtain Activation Result from Licensing Portal **From the *****Licensing Portal***** (**[https://litmus.activate.id/offline](https://litmus.activate.id/offline)**) tab:** 1. Paste the activation request in the **Activation Request** field, and then click **Make License. **(You may need to verify **I'm not a robot.**) The encoded license appears in the *Activation Result* field. 2. Next to the *Activation Result** ***field, click the **Copy** **content to clipboard** icon to copy the encoded license. 3. Return to the *Offline License Activation* / *Upgrade License offline* section. ### Step 3: Submit Offline Activation Key **From the *****Offline License Activation***** / *****Upgrade License offline***** section again:** 1. Paste the encoded license in the **Offline Activation Key **field. 2. Click **Submit**. The license is added. # Features You can filter and view features that are available for your plan from the *Features*** **section in the *Licenses*** **module. This section allows you to monitor which features are unlocked and available by the licenses. You can filter for a specific feature or group of features. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/9inSwCisj5ceEuO0Vis_C_image.png" size="80" width="1894" height="317" position="flex-start" caption="License Features" darkWidth="1894" darkHeight="317" showCaption="true"} \[6] **Show Filter** / **Hide Filter: ** Search by *Features* [title] Edge Devices [path] Litmus Edge Manager Admin Console/Product Features/Edge Devices/ The Edge Devices module provides a comprehensive list of all the edge devices that are activated with Litmus Edge Manager. Within this module, you will be able to view details such as the name, description, activation status, version number, and the date and time the edge device was created. # Access Edge Devices UI **To access the Edge Devices UI: ** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Edge Devices**. *Edge Devices* list pane by default appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/oZ9AMlAGMZLzVHwTmb_9C_image.png) [title] LEM Settings [path] Litmus Edge Manager User UI/Product Features/ The Settings module is accessible for a company and from an open project. The *Company Settings* module contains two tabs which are used to configure the company and its projects. The *Project Settings* module contains four tabs which are used to configure a specific project. # Company Companies are the main organizational unit that you can define on Litmus Edge Manager. Companies contain company teams that define company-wide access privileges. Companies also contain company projects, which can represent individual plants that a company operates. [Company Settings](docId\:XwUuYveHjgIbb0bYwlwSt) # Projects Projects represent an individual plant that a company operates. They contain the devices and models needed for plant operations. Projects have separate team access privileges from the teams defined for companies. [Project Settings](docId\:hmGSXiivMvDy4K43OanRv) [title] Alerts Guides [path] How-To Guides/Litmus Edge Manager User UI Guides/ Refer to the following Alerts how-to guides: - [Create an Email-Alert Trigger for DeviceHub Device Data Quality](docId\:keO0ctAMmo949dTzLGw7V) - [Create an Email-Alert Trigger for Connector Online Status](docId\:da-gvxuEPnYfpaTsSYhcq) - [Create an Email-Alert Trigger for DeviceHub Device Status](docId\:yCko-JWAqn-lTpa88w9yY) [title] Product Updates [path] / Review product updates for Litmus Edge Manager: - [2026](docId\:mcH93J7L4f9gnh1wUB9RX) - [2025](docId\:rFvAkyOCvNEqMWyYpHUrT) - [2024](docId:-17soa4j2iSXueWhfl_A_) - [2023](docId:2hEyJ2u_5W1Z3aM2bd1sB) - [2022](docId\:FM0PQP69F5si8uahCa-Hf) - [2021](docId\:hMzr1MCVJkWT28UPAYPje) - [2020](docId:5I5JvhW4u0N9OAys0SYqf) [title] Litmus Edge Manager 2.26.4 [path] Product Updates/2025/ Release Date: October 10, 2025 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Enhancements and Improvements | Description | | ------------------------------------------------------------------------------------- | | **APIs:**
* We've improved performance when returning a large number of devices. | [title] Litmus Edge Manager 1.7.2 [path] Product Updates/2020/ Release Date: June 16, 2020 ## Enhancements and Features The following issues that existed in one or more previous releases have been resolved: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Zero-touch provision for Litmus Edge**:
* Litmus Edge Manager now provision to deploy Litmus Edge with License Key, Certificates, cloud URL, Integration Configurations automatically. This feature helps in bulk activation of Litmus Edge from Litmus Edge Manager | | **Litmus Edge deactivation from Litmus Edge Manager**:
* Improvements have been added with this release for deactivation of Litmus Edge from Litmus Edge Manager. More validation and verbose have been added to carry out this process seamlessly. | | **Improved Litmus Edge device removal workflow**:
* Improvements have been added with this release to the workflow for removal of Litmus Edge from Litmus Edge Manager. More validation and verbose have been added to carry out this process seamlessly. | | **Smooth upgrading of Litmus Edge marketplace application**:
* Marketplace application can be upgraded with new parameters to Litmus Edge. | | **Support of Litmus Edge Marketplace templates**:
* Supports marketplace apps in template deployment. | | **Litmus Edge services management from Litmus Edge Manager**:
* A Litmus Edge Manager administrator can start/stop/restart services like remote access, ssh, devicehub and flows from Litmus Edge Manager. | | **Click-house access for 3rd party reporting tools**:
* Click-house access is available is for user to import the data to other databases for further reporting tools. | | **Private Docker registry improvements**:
* Admin user can upload docker images to Litmus Edge Manager Admin Console, these images can be used for Litmus Edge application deployment. There is also option to pull docker images from another registry. | | **DockerHub registry mirroring**:
* Litmus Edge Manager manage proxy authentication and state for docker registry. | | **Maintenance - Configuration step isn't needed anymore**:
Manual configuration steps are not required for VM deployment and there is a field in Admin console to edit the domain name under settings. | | **Maintenance - Litmus Edge Manager updates are supported now**:
* Litmus Edge Manager admin user can upgrade to next version of Litmus Edge Manager from Admin console. .upd file has to be uploaded to have it under New versions section in order to deploy the version. Admin user can click on the upgrade button to apply the upgrade. Previous versions can also be upgraded or removed manually from this section | | **Litmus Edge Manager domain names management from Litmus Edge Manager Admin UI**:
* Litmus Edge Manager admin console now has the feature to update domain names. System will validate the URL before having it saved. | | **Introduced SSL certificates management (Instance, Let's Encrypt, Custom)**:
* User had to use command line to set up the certificate now this is possible from the Admin UI, which makes user journey much easier. | | **Introduced SSL certificates management (Instance, Let's Encrypt, Custom)**:
* User had to use command line to set up the certificate now this is possible from the Admin UI, which makes user journey much easier. | | **Various UI/UX improvements and bug fixes**:
* Improved UX and UI experience have been added with this release. | ## Known Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------- | | Failure on all file upload of Litmus Edge on Litmus Edge Manager Admin Console on FireFox browser with self-signed certificate. | [title] 2023 [path] Product Updates/ - [Litmus Edge Manager 2.15.0](docId:7hBD9pBSIfVwVCQ2ChLj5) - [Litmus Edge Manager 2.14.0](docId\:OXUIBOHHuPTV2cLdpX8Ql) - [Litmus Edge Manager 2.12.0](docId\:CfyQJ1z4Pwa6BLURFxXrm) - [Litmus Edge Manager 2.11.0](docId\:L89rUk090GzKigFOnmMAu) - [Litmus Edge Manager 2.10.2](docId:7A7kkkSuR1ziJR-Ui2zQZ) - [Litmus Edge Manager 2.8.2](docId\:gOeM_DGKG4vIHBtwUTPjl) - [Litmus Edge Manager 2.8.1](docId:-o1veUqMYBmvwUnOaCxnM) - [Litmus Edge Manager 2.8.0](docId:1V0n4Epl3yg6HRM6p2QOn) [title] Litmus Edge Manager FAQs [path] Resources/ :::ExpandableHeading How can I try Litmus Edge Manager? - You can get started with Litmus Edge Manager: [Getting Started](docId\:HnHQ6RBL35VCUa7ySVIII)  - Read about Litmus Edge Manager here: [Litmus Edge Manager User UI](docId:-sKldTrdGJ49xNOa3yycd) ::: :::ExpandableHeading Can I use Litmus Edge Manager without Litmus Edge? No, Litmus Edge Manager is based on the model purchased from Litmus. Litmus Edge Manager is the management suite for Litmus Edge. ::: :::ExpandableHeading Why don't I see device attributes, such as manufacturer and model number, in the device INFO tab? These attributes are sent by the devices. If it does not display: - Check the device status from the *Edge Devices* pane to see if data is connected. See [Step 7: Verify Edge Device Activation in Litmus Edge Manager](docId\:KC9sqRSng2KSINWL1PfPi). - Check the device information in the edge device. See [Info](docId:6_6LCntLNjWrq1JBqAS8e). ::: :::ExpandableHeading What could be some reasons that my device is not connecting? - Try double checking your connection parameters. - If the parameters are correct, check your firewall settings. ::: :::ExpandableHeading Why can I see device data in the RAW tab, but not in the EXPLORE tab? Data sent to Litmus Edge Manager must be in a special format, as shown in the JSON schema in the Project settings page. If Litmus Edge Manager cannot parse incoming messages, the messages only appear in the **Raw** tab. ::: :::ExpandableHeading Why can't I access the Litmus Edge Manager or Litmus Edge Manager Admin Console UIs after rebooting my VM? This may be happening because your VM is configured with DHCP and received a new IP address after the reboot. **For LEM version earlier than 2.31.0:** Log in to the Admin Console and change the base domain name to the new IP address. **For LEM version 2.31.0 and later:** 1. SSH to the VM and obtain root access. 2. Edit `/etc/default/lem-common`. 3. Change `LEM_BASE_DOMAIN_NAME` to `lem.local`. 4. Wait 5 minutes for the system to reconfigure the domain names and then log in again. ::: :::ExpandableHeading How can I remotely manage a device? Litmus Edge Manager supports MQTT protocol to remotely manage a device: **MQTT** Litmus Edge Manager supports 3 types of MQTT topics: - request - to send manage requests to a device - response - to receive responses from a device - data - to receive data from a device Request/response formats are not defined. For example: If you can program your device to reboot when it receives `{"command": "reboot"} `from the request topic, you can reboot your device remotely. If you open the MQTT tab on the Device Details form, you can see Request/Response tabs to manage MQTT devices online. To accomplish management tasks, you must program your device. The Batch Device Management feature offers operations similar to those described above, but you can define batch commands (MQTT) and schedule these commands to execute against a group of devices. ::: :::ExpandableHeading How can I delete a Project? You can remove a project from the **Project List** or from the **Remove Project** section in the **Project Settings** > **Settings** tab. ::: :::ExpandableHeading How can I visualize my data? Use Litmus Edge. All data that appears in the **Explore** tab is available in Litmus Edge as well. ::: :::ExpandableHeading Are messages sent from Litmus Edge to Litmus Edge Manager Secure? - We do security testing with every release. - We prevent security issues through REST and MQTT protocols. They only use secure transports, such as TLS and DTLS. We do not support unencrypted transports between the two products. - All security credentials established during cloud activation are securely stores on the Litmus Edge device and they are not exposed to the end user. It is impossible to alter these credentials after activation as long as physical security of the Litmus Edge gateway is maintained. ::: :::ExpandableHeading What is the difference between Litmus Edge Manager Alerts, Events, and Incidents? - **Alert** - The Litmus Edge Manager Alerts feature allows a user to define notifications based on rules. Rules comprise a set of conditions that define an abnormal state of a device. For example: No data received from a device in more than two minutes, or the temperature went below 30 degrees. First, define Actions. Actions are the types of notifications, such as Slack or Webhook. Then, create a Trigger. A trigger is a combination of device tags, a set of rules, and an action. Once triggered, Litmus Edge Manager sends the alert notification to the defined destination. Alert notifications can be viewed on the Litmus Edge Manager dashboard as well as from email and third-party web applications, such as Slack. The Incidents tab on the projects page lists the alerts that were generated. - **Event** - Events list the Litmus Edge Manager configuration activities that occurred for a project within a company. For example: Added a new project, or deployed a new device. - **Incident** - If a device reaches an abnormal state according to the rules, then Litmus Edge Manager will create a new incident and send notifications. The *Incidents* tab lists the alerts that were generated. When a device returns to a normal state, the open incident will be closed and Litmus Edge Manager will send another notification with an incident resolved message. ::: :::ExpandableHeading How many Litmus Edge devices can Litmus Edge Manager manage? As many as you want, purchased or installed on the Site. ::: :::ExpandableHeading How do I file a support ticket? Download the support bundle and attach it with the support ticket that you create in the support portal in an email. To create a ticket and attach the support bundle, go to [https://litmus.io/contact](https://litmus.io/contact/). Click **Support Portal**. ::: :::ExpandableHeading What is the ESXi version minimum requirement for Litmus Edge Manager deployment? We strongly recommend ESXi version 6.7 or higher. ::: :::ExpandableHeading What are the technical details I can verify before raising a support ticket? Find out the following: - The version of the Litmus Edge and the Litmus Edge Manager. - The version of a component if it is not working. - The type of license installed. - If the network is properly configured. - If the NTP/DNS settings are correct. - If you are using the correct PLC driver and IP address. ::: :::ExpandableHeading How long is alert history retained within Litmus Edge Manager? Alert history is not deleted. It is kept as long as there is space in the database. ::: :::ExpandableHeading What happens if the database for alert history becomes full? After the alert history database becomes full, the system stops accepting data. In upcoming releases, we will develop a more sophisticated data life cycle management. ::: :::ExpandableHeading Do any security settings, such as active directory settings or certificate policies, get deployed when implementing a template on a Litmus Edge device from Litmus Edge Manager? Not at this time. In upcoming releases, Litmus Edge Manager will be able to deploy LDAP/AD settings for various Litmus Edge devices. ::: :::ExpandableHeading Can I deploy selected flows from a template to a selected Litmus Edge device from Litmus Edge Manager? Currently, a template consists of: PLC configurations (device settings and tags) and Flows. You can select a mix of both types and create as many templates as you want. These templates can then be uploaded from the Litmus Edge Manager Admin Console so that they are available to all the companies, or from the Litmus Edge Manager at a Company level so that they are available to all the Projects. You can create different groups of Litmus Edge devices and select which template you want to deploy to a selected group of devices. In upcoming releases, we will include CC as well as a few other configurations. ::: :::ExpandableHeading What BI tools can be connected to Litmus Edge Manager? - Litmus Edge Manager supports the MySQL protocol for ClickHouse. If the BI tool supports MySQL, it can connect to ClickHouse. Some smart BI tools may use MySQL system tables that are not present in ClickHouse, so they should be tested. - Litmus Edge Manager allows you to connect to the ClickHouse underlying database. See [https://clickhouse.tech/docs/en/interfaces/third-party/integrations/](https://clickhouse.tech/docs/en/interfaces/third-party/integrations/) to find the native connectors that ClickHouse uses. ::: :::ExpandableHeading Why am I unable to activate an edge device? How do I fix this? When an activation fails, there will be an Activation Stage Message that reports the exact cause(s). Here are some potential fixes: - Ensure port 443 is opened. - Ensure 51820/UDP is open for the Litmus Edge instance. - Ensure the Remote Access protocol is not blocked at all. - Ensure the time synchronizations setting between the Litmus Edge Manager and Litmus Edge is working properly. - For Docker-run Litmus Edge instances, check for `NETADM` capability. - For \<3.2.0 Litmus Edge instances, ensure Remote Access modules on each host system (where the LE is installed) are operating properly. ::: :::ExpandableHeading How to backup my instance for Litmus Edge Manager? The backup process for LEM consists of a compressed file downloaded from the LEM Admin UI. The data is updated every 24 hours and is maintained on the server for seven days. See [https://docs.litmus.io/edgemanager/admin-console-backup ](https://docs.litmus.io/edgemanager/admin-console-backup)for details on how to backup LEM. ::: :::ExpandableHeading What is the difference between Litmus Edge and Litmus Edge Manager backup files, and how can they be restored? LE backup files have a `.dat` file extension, while LEM backup files do not have any file extension. Both types of files are used to restore devices to their last backed-up state, but LE backups can only be restored through the LE user interface, while LEM backups must be restored through the LEM platform and cannot be uploaded directly to the LE UI. ::: [title] Litmus Edge Manager 2.16.5 [path] Product Updates/2024/ :::hint{type="warning"} **Important**: For a seamless upgrade experience in upcoming releases, it's crucial to upgrade to version 2.16.4 before making any further upgrades. Skipping the initial upgrade to version 2.16.4 may disrupt the upgrade process, and is therefore not recommended. ::: Release Date: April 29, 2024 ## Enhancements and Features | **Description** | | -------------------------------------------------------------------------------------------------------------- | | **Edge Devices**:
* Added logging for the deactivation process for an edge device in the API actions log. | ## Resolved Issues | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Dashboard**:
* Fixed issue with dashboard labels not correctly corresponding to edge devices in charts. * Fixed issue with dashboard page displaying unresponsive text on a smaller screen. | | **Security: **
* Resolved vulnerabilities related to the following: - CVE-2024-1597: Fixes a vulnerability from the PostgreSQL JDBC driver, pgjdbc, that allows a user to inject SQL if using `PreferQueryMode=SIMPLE`. - CVE-2021-38153: Fixes a vulnerability in Apache Kafka that used "Arrays.equals" to validate a password or key. - CVE-2023-25194: Fixes a vulnerability in Apache Kafka Connect API that allowed authenticated operators to execute java deserialization gadget chains on the Kafka connect server. - USN-6459-1: Fixes several security issues in MySQL. - USN-6615-1**: **Fixes several security issues in MySQL. | | **User Interface**:
* Fixed issue where the initialization page for nginx config wasn't shown during the first boot in the Litmus Edge Manager user interface. * Fixed issue for the upload UPD dialog box not closing after a successful upload. * Fixed issue with site cards not displaying correctly after reloading the page. * Fixed issue with % data on the Disk Usage graph not displaying correctly. | | **Sites:**
* Fixed issue with `Error 403` message displaying when adding a second site with no image. | | **Support**:
* Fixed issue with `lem-admin` logs not being included in support bundles. | | **Events**:
* Fixed issue with the incorrect system event description displaying. | [title] Litmus Edge Manager 2.16.7 [path] Product Updates/2024/ :::hint{type="warning"} **Important**: For a seamless upgrade experience in upcoming releases, it's crucial to upgrade from version 2.16.4 to 2.16.7 before making any further upgrades. Skipping the initial upgrade to version 2.16.4 and then 2.16.7 may disrupt the upgrade process, and is therefore not recommended. ::: Release Date: Aug 21, 2024 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Resolved Issues | **Description** | | ------------------------------------------------------------------------------------------- | | **Security: **
* Updated Nginx configuration to address a security vulnerability. | [title] Litmus Edge Manager 2.8.1 [path] Product Updates/2023/ Release Date: February 8, 2023 ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Device Details:**
* Fixed an issue where the data connection (between a Litmus Edge and Litmus Edge Manager) was displaying incorrectly when the Litmus Edge Manager was upgraded. * Fixed an issue where Litmus Edge instances were shown as offline and cease the connection with the Litmus Edge Manager when the Litmus Edge Manager was upgraded. This occurred when the Litmus Edge Manager used a IPv6 remote network. | ## Deprecated Components and Features The following components/features will no longer be available: | **Description** | | ------------------------------------------------------------------------------------------------- | | **Dashboard:**
* Performance content has been removed for this version of the Admin Console. | ## Known Issues The following issues are unresolved in this release: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------- | | **Edge Devices**:
* An edge device may incorrectly display `No active license` warning even though it does have a license. | | **Network:**
* The error message for adding incorrect NTP server doesn't provide enough details. | [title] Visualizing ClickHouse Data with Tabix: A Step-by-Step Guide [path] How-To Guides/Litmus Edge Manager Admin Console Guides/ Tabix can be used to retrieve and display PLC data from a Litmus Edge Manager. You can then execute SQL queries onto the PLC data. # Before You Begin - Ensure that the Clickhouse port 8543 \[`HTTPS`] is enabled. See the *Change port status state* option in [Clickhouse](docId\:MD6NfAz8rrs1p_JWPaIm-). - Create a Clickhouse User. See the *Create User* option in [Clickhouse](docId\:MD6NfAz8rrs1p_JWPaIm-). - Associate the created Tabix User with a Topic (Company / Project). See the *Add ACL* option in [Clickhouse](docId\:MD6NfAz8rrs1p_JWPaIm-). # Log into Tabix To initially enter Tabix UI from the Litmus Edge Manager Admin Console, see the *Open Tabix* option in [Clickhouse](docId\:MD6NfAz8rrs1p_JWPaIm-). You can click the `HTTPS_CONN` button to automatically fill in the *Title* and *URL*. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/B8p0kQUgGEJ1TwfcotN4f_image.png" size="80" width="1502" height="669" caption="Logging into Tabix" position="center" showCaption="true"} - **Title**: By default, this is `HTTPS_CONN`. - **URL**: `https://` followed by the IP address / domain name of the Litmus Edge Manager instance, followed by`:8543`. - **User**: This is the Clickhouse username that was created from earlier and associated with a Topic. - **Password**: This is the Clickhouse user's respective password that was created from earlier. - **Mode**: Keep it as `Normal mode`. Once you are successfully logged in, all the `Database Name`(s) that were created from an association between a *Clickhouse* user and *Topics (Company/Project)* will be available. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/i4uHJS9_vDzKGztJOCJDP_image.png" size="80" width="1920" height="866" caption="Database names same" position="center" showCaption="true"} ## Using Tabix From there, you can view additional data and execute SQL queries in Tabix. For more information about Tabix, see [https://tabix.io/doc/](https://tabix.io/doc/). ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/8oHACJq1_3hRXexRa3Xiq_image.png" size="80" width="1920" height="866" caption="Tabix UI" position="center" showCaption="true"} \[1] **Access default sql query drop down menu:** Right click on one of the five tables below the Database name. \[2] **Enter SQL query: **See [Clickhouse SQL Reference](https://clickhouse.com/docs/en/sql-reference) for details \[3] **Run current SQL** \[4] **View SQL query results** ## Example SQL Query on Tabix ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/2Z-7cvTI2jCPeetPU0Bk__image.png" size="80" width="1836" height="807" caption="Example Tabix UI" position="center" showCaption="true"} [title] Litmus Edge Manager 1.9.2 [path] Product Updates/2020/ Release Date: December 28, 2020 ## Enhancements and Features The following issues that existed in one or more previous releases have been resolved: | **Description** | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Resolved Issues: **
* Updated single role for a user * Updated multiselect feature as per supported edge features * Fixed issue with expired licenses for edge system * Improved error messages * Minor UI fixes | ## Known Issues The following issues are unresolved in this release: | **Description** | | -------------------------------------------------------------------------------------------------------------------------------- | | - Failure on all file upload of Litmus Edge on Litmus Edge Manager Admin Console on FireFox browser with self-signed certificate | [title] Litmus Edge Manager 2.26.2 [path] Product Updates/2025/ Release Date: July 25, 2025 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Resolved Issues | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **APIs:**
* Fixed compatibility issue with the Litmus Edge Manager API bridge and certain Edge Marketplace APIs. | | **Marketplace:**
* Fixed issue where an **undefined** message occured when pushing Marketplace catalogs to specific edge device instances. * Fixed issue where an error prevented saving component details after correcting initial input errors in *Marketplace*. * Fixed issue where the *Application* table inaccurately counted deactivated Edge Devices in total devices displayed. | [title] Visualize Child Device Data Using Grafana [path] How-To Guides/Litmus Edge Manager User UI Guides/ You can visualize the data a device publishes to Litmus Edge Manager using Grafana. To receive the `Admin` role on Grafana Dashboards, see the *Toggle Administrator role for Grafana* *section* of [Edit a User Profile](docId\:KIJgyCJC1HGIm8mW7dVRK). # Before You Begin You must select the **RAW data** option for the Edge Device Data Storage setting (**Litmus Edge Manager User UI** > **Company **> **Project **> **Settings **> **Edge Device Data Storage**). See [Project Settings](docId\:hmGSXiivMvDy4K43OanRv) to learn more. # Visualize Data in Grafana **To visualize data in Grafana:** 1. Make sure your child device data in Litmus Edge Manager is displaying correctly. See [View Data from an Edge Device or a Child Device](docId\:E6vquqVSqtUfJIyhmFgOo). 2. From the navigation panel, select **Features**. The *Features *pane appears. 3. Click the **Grafana Dashboards** tile. Grafana opens in a new browser tab. 4. From the Grafana navigation panel, click the **Dashboards** icon, and then select **Browse** from the menu. The **Dashboards** pane appears. 5. Click the **Samples** folder. This is available by default. 6. Click the **PLC Tag Browser link**. The graph loads. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3froepg91K-2wqMJeOovb_image.png" size="80" width="1920" height="914" caption="Grafana Visualized Data of Child Devices" position="center" showCaption="true"} ## Customize the Grafana Data Visualization **To customize the Grafana data visualization**: 1. Use the **PLC Tag Name **drop-down list to select tag(s) to display. 2. Use the **Device **drop-down list to select the child device(s) to display. 3. From the top right corner, use the dashboard's toolbar options to change the graphs' time range and refresh interval. 4. From the **PLC Tag rates **drop-down list, select the **Edit** option**. **The **PLC Tag Browser > Edit Panel** pane appears. - Hover over the chart to view specific values. - From the bottom right corner, use the **Query **tab to view and edit the various queries used in the chart. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Bfga-hgYv2ZxFEVqQ0kL0_image.png "Grafana: PLC Tag Browser > Edit Panel") [title] Deploy an Application to Edge Devices [path] How-To Guides/Litmus Edge Manager User UI Guides/ You can deploy an application to one or more edge devices. After selecting** Launch App** for an application, see the information below on deploying the application. # Before You Begin - Connect a repository. See *Add new repository *in [Registry Management](docId\:M6yzedYRAwwYDnLDtOQlZ). - Create a marketplace catalog for your application and then add the application. See *Add Catalog *and* Add or Import an application *in [Marketplace: Catalogs and Applications](docId\:gqoGt_Szm8rz9UdPhl2NL). - Submit the application release you want to deploy. See *Submit Release *in [Manage Application Releases](docId\:FoZMtmXkxEI6Y-gPZAEvg). - Ensure each of Litmus Edge devices have enough disk space to receive the Docker application release’s associated Docker image(s). # Step 1: Select at least one online device ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/gQVndUEszbybcLweTvEWb_image.png "Deploy an Application Step 1 : Select at least one online device") \[1] **Filter by Groups** \[2] **Select all displayed edge devices ** \[3] **Select edge device** \[4] **View Data | Control status** **To select one or more edge devices: ** 1. (Optional) From *Edge Devices* tab, select one or more groups. 2. Select one or more edge devices. 3. Click **Next**. # Step 2: Application Settings ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/N0Cef5Mx7bCZKcsXB9KyD_image.png "Deploy an Application Step 2 : Select application settings") \[1] **Change Application Name** \[2] **Change Application Release** \[3] **Set Application Parameters:** Unique set of parameters for each Application. See [Set Up Variables for an Application Release](docId\:HF5YyWh3bwhFi6m2jKxHt) for details on how set up the parameters for each application. The parameters will be applied to the application’s respective Docker image. When the Litmus Edge receives this application and its respective Docker image, these parameters will be passed as runtime variables to this application’s respective Docker container. **To configure application settings: ** 1. From** ***Apps Settings* tab, select a submitted release from the **Application Release** drop-down list. 2. (Optional) Make changes to other parameters, then click **Next**. Update options depend on the application selected. # Step 3: Preview ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/YU-0tFKleeGIy0iE4M1zD_image.png "Deploy an Application Step 3 : Preview") \[1] **Review Device(s) names** \[2] **Review Application Name and Release** \[3] **Review Parameter Settings** **To preview application deployment configurations: ** - From the **Preview** tab, review your selections, and then click **Launch**. # Step 4: Result ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/IARBE5msMbg61WI7L3jQ-_image.png "Deploy an Application Step 4 : Result") \[1] **View Edge Device Details:** [Apps](docId\:pwQmgXarWxphcibP2z12U) \[2] **View** **Message** **To finalize application deployment: ** 1. From the *Result *tab, wait for values under the *Message column *to confirm successful deployment(s). 2. Click **App Details**. The selected edge devices appear in the Edge Device list on the selected *Application Details* pane. The initial App Status for the deployed devices should be `PULLINGIMAGESTARTED`. Wait for the Docker image pull operation to complete or fail. A new App Status will be shown. # Step 5: Verify Deployed Application is Running **To verify the deployed application is running: ** 1. From the *Application Details* pane, click the edge device **ID** link. 2. The selected application is displayed as running on the **Apps** tab in **Edge Device Details**. See [Apps](docId\:pwQmgXarWxphcibP2z12U). If the App Status displays as a `LAUNCHERROR`. It indicates that the Docker image pull operation failed. Ensure that the Application’s respective Docker image registry location is a valid one (See [Set Up Docker Container Configurations for an Application Release](docId\:mebpl6tcgzj9NS2Cmk5cQ)) or your Litmus Edge instances can connect and access the registry location. # Step 6: Verify the Application on the Edge Device For the edge device, check its [Containers](docId\:uASMDJ5ugFN_P79HOba3Y) section to verify the respective application container is running for the application. [title] Litmus Edge Manager 2.8.0 [path] Product Updates/2023/ Release Date: February 7, 2023 ## New Features The following are new features introduced in this software release: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------- | | **License Server Management:**
* Offline activation now allows you to select and add two types of licenses (Core License or Add-on License). | | **Network:**
* Redesigned *Network* to now also feature an *Interface* tab and an *NTP* tab. | ## Enhancements and Features The following features and enhancements are included in this software release: | **Description** | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Task List and Task Details**:
* Added additional multi-Litmus-Edge operations that can be monitored by Task List. | | **Dashboard**:
* The Dashboard now also supports Processed/Failed tags metrics. | | **Edge Device**:
* Edge Devices List now also show processed/failed tags metrics  | | **Edge Device Details**:
* This tab is now always available regardless of Marketplace license availability. | | **Edge Device Details**:
* Multiple Select is now supported to delete multiple backups. | | **Applications**:
* Application Details now display Device ID and Device Status. | | **Marketplace**:
* For Application Releases, variables can now be configured as *private*. This will make the variable values display as asterisks during deployment. | | **Admin Console Settings**:
* Support bundles now contain NTP Server Logs. | ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Asset Management**:
* Fixed an issue with dark/black images blocking turning certain user interfaces invisible. | | **Edge Device Details**:
* Fixed an issue with Litmus Edge Events not displaying. | | **License Server Management:**
* Fixed an issue with License Server not accepting additional tag licenses. | | **Admin Console Settings:**
* Fixed an issue where after changing base domain name, location http header was still referring to the old base domain name. | | **Admin Console Settings: **
* Fixed issue where after upgrading to 2.7.0 Kafka SSL keystore became broken.
| | **Security:**
* Resolved a vulnerability related to CVE-2022-4116, CVE-2022-32221. | ## Deprecated Components and Features The following components/features will no longer be available: | **Description** | | ---------------------------------------------------------------------------------------------------------- | | **Edge Device Details**:
* Metrics are not available for Litmus Edge versions below 3.2.0 and 21.5.0. | | **Edge Device Details**:
* The *Explore* tab has been removed. | | **Integration**:
* When adding an ACL, lwm2m topics are no longer available. | ## Known Issues The following issues are unresolved in this release: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Login**:
* Incorrect LEM System/User Local time may break authentication. | | **Edge Devices**:
* Device list may be empty momentarily as it is actually loading. * An edge device may incorrectly display `No active license` warning even though it does have a license. * An edge device may incorrectly display Data status. * Litmus Edge instances may be shown as offline and cease the connection with the Litmus Edge Manager when the Litmus Edge Manager was upgraded. This occurred when the Litmus Edge Manager used a IPv6 remote network. | [title] Litmus Edge Manager 2.22.4 [path] Product Updates/2024/ Release Date: Dec 12, 2024 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Enhancements and Improvements | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Licenses:**
* The system now displays an error message when the selected quantity of Edge devices exceeds the key availability for certain SKUs. | | **Alerts:**
* You now have updated PagerDuty trigger action field within the *Edit Action *dialog box, where field name `Token` has been renamed to `Integration Key`. | ## Resolved Issues | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | | **Licenses:**
* Fixed issue where the *License Summary *screen incorrectly displayed expired Add On licenses as Active. | | **Security:**
* Fixed issue where the MPCS registry list request returned a `502 error` due to a nil interface conversion. | [title] Litmus Edge Manager 2.10.2 [path] Product Updates/2023/ Release Date: May 10, 2023 ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ---------------------------------------------------------------------------------------------------------------------- | | **Marketplace:**
* Fixed an error where Catalogs cannot be added for a newly installed Litmus Edge Manager. | | **Security:**
* Resolved a vulnerability related to CVE-2023-20873. | ## Known Issues The following issues are unresolved in this release: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Templates:**
* When uploading an invalid Parameterized Template (*.zip* folder), it will yield a successful result message but won't add the template. | | **Edge Devices:**
* Expired site-based licenses do not display their expired status. | | **Alerts:**
* Metrics alerts for Connector online status may not operate properly. | | **Upgrade:**
* Users are able to downgrade Litmus Edge Manager to an earlier version. | [title] Resources [path] / [title] Manage Site License Allocation [path] How-To Guides/Litmus Edge Manager Admin Console Guides/ You can manage site licenses and control data point allocation across companies and projects using your Admin Console. A site license provides a shared pool of data points that all connected Litmus Edge instances can access, regardless of the company or project they belong to, as long as the total number of data points used does not exceed the site license limit. The [License Server Management](docId:5U_hNNsaVs--E5HQJEQ0O) tab in Litmus Edge Manager Admin Console allows for sub-allocating data points from this shared pool to specific projects, providing more granular management and preventing overconsumption by any single project. This feature improves the flexibility and control over data point usage, ensuring fair allocation and distribution. :::hint{type="warning"} **Important Notes:** - The license allocation feature is exclusively for site licenses and not for node-locked licenses. - Even if a data point allocation has expired, the project might still be able to use more data points than the expired allocation if there are still available data points in the overall site license pool. ::: # User Scenario A manufacturing company holds a 1000-point site license and manages four key projects. To ensure effective resource allocation, the company has designated 100 points for the North project, 100 points for the South project, 100 for Research and Development (R\&D), and 100 for Quality Assurance (QA). You can also specify any expiry date for the allocation of data points. Before You Begin Ensure that you have: - A valid site license activated in Litmus Edge Manager. - Identified the company and project for which you want to allocate data points. # Step 1: Add a Company Add a new company with a suitable name or select the appropriate company from your organization. See [Add a Company](docId\:QS1mbPG-tWRCyAAWe5Iya) for more details. # Step 2: Add a Project Add four different projects with the following names: *NorthProject*, *SouthProject*, *RAD*, *QA.* See [Add a New Project](docId\:Hd7WK8HYKXXJVflDfIgky) for more details. # Step 3: Add an Edge Device(s) See [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) for more details. # Step 4: Accessing the License Allocation Page 1. Navigate to the **Litmus Edge Manager Admin Console** > **License Server Management**. See [License Server Management](docId:5U_hNNsaVs--E5HQJEQ0O) for more details. 2. Click on the **Allocation **tab. On the **Allocation** page, you can view the current data point allocations. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/R09FTo4V2FtrQtmNRnM2r_image.png" size="80" width="1327" height="543" position="flex-start" showCaption="false" indent="2"} # Step 5: Allocating Data Points to Project(s) 1. On the **Allocation **page, click the **Add allocation (+)** to initiate a new data point allocation. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/wvgGqzHKUH6tRb_BEzVvA_image.png" size="72" width="1863" height="892" position="flex-start" showCaption="false" indent="2"} 2. The **Edit Allocation** dialog box appears. Take the following actions: - **Company / Project: **Choose the company that contains the project for which you want to allocate data points. - In our case, select the company with all the projects we added in *Step 2 *above: **NorthProject, SouthProject, RAD, and QA.** ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/CQeM04Ujco08GjcF2fPgZ_image.png" size="40" width="397" height="323" position="flex-start" showCaption="false" indent="4"} :::Paragraph{listStyleType="disc" listStart="2" indent="2"} **Allocated Data Points: **Enter the desired number of data points you want to allocate to the selected project in the designated field. ::: :::Paragraph{listStyleType="disc" listStart="3" indent="2"} **Expiry Date: **Set an expiry date for the data point allocation. ::: :::Paragraph{listStyleType="disc" indent="3"} Click on the calendar icon or enter the date to specify when the allocation should expire. ::: :::Paragraph{listStyleType="disc" listStart="4" indent="2"} Click **Save**. ::: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/iah3xSkoVvcUnZouHPsdo_image.png" size="40" width="398" height="321" position="flex-start" showCaption="false" indent="3"} 3. The new allocation will be visible in the allocations table. You can see the allocated data points, the expiry date, and how many data points are currently in use within that project. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/QaphkPojkgiBRZ7YiDANH_image.png" size="70" width="1179" height="855" position="flex-start" showCaption="false" indent="2"} # Step 6: Managing Existing Data Point Allocations On the **Allocation **page, you have several options to manage existing data point allocations via the action tab associated with each allocation: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Q6Qu7nE0C6WH92l3EyllH_image.png" size="80" width="1867" height="589" position="flex-start" showCaption="false"} | Action | Details | | -------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | \[1] **Search** | Use the search functionality to find specific allocations based on company, project, or other relevant criteria. | | \[2] **Export** | Click this option to export the current allocation data in a CSV format. | | \[3] **Refresh** | Click the refresh list icon to update the allocation table and display the most current information. | | \[4] **Edit Allocation** | Click the edit option to modify the expiry date or increase the number of allocated data points for a project. | | \[5]** Delete Allocation** | Click the delete option to remove the data point allocation that you have set for a project. | [title] Manage Certificates with DigiCert IoT Trust Manager Integration [path] How-To Guides/Litmus Edge Manager Admin Console Guides/ :::hint{type="info"} **Note**: The DigiCert IoT Trust Manager integration is available for Litmus Edge Manager 2.21.0 and later. ::: In this use case, you will integrate DigiCert IoT Trust Manager with Litmus Edge Manager (LEM) to manage certificates for all your edge devices. - First, you will set up the DigiCert IoT Trust Manager Integration from your Litmus Edge Manager Admin Console. - Then, you will configure the Certificate Authority (CA) for both Litmus Edge Manager and Litmus Edge (LE) devices. - Finally, you will verify if the DigiCert certificates are applied to your Litmus Edge devices. # Before You Begin - Ensure you have at least one Edge device activated in your Litmus Edge Manager. See [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) for more information. - Ensure you have access to the DigiCert IoT Trust Manager to obtain the required configuration parameters. If you are not a DigiCert IoT Trust Manager customer, visit [https://www.digicert.com/device-trust-manager](https://www.digicert.com/device-trust-manager) to sign up. # Step 1: Access DigiCert IoT Trust Manager Integration **To access the DigiCert IoT Trust Manager integration pane: ** 1. Log in to the Litmus Edge Manager Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the Navigation panel, select **Integration**. Integration's *Kafka* pane by default appears. 3. From Integration's navigation sub-panel, select **DigiCert**. Integration's* DigiCert *pane appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/uvNWw2-L0ozYiP8jAP56j_image.png "DigiCert IoT Trust Manager Integration pane") You will see three fields for configuration: **URL**, **Profile ID**, and **Passcode**. By default, placeholder values will be in these fields. In the next step, you will retrieve these configuration parameters from the DigiCert IoT Trust Manager. # Step 2: Set up Integration with DigiCert **To retrieve the URL, Profile ID, and Passcode parameters from the DigiCert IoT Trust Manager, follow the steps below:** 1. Open a new browser and log in to your **DigiCert ONE **platform at [https://one.digicert.com.](https://one.digicert.com/) 2. Select *IoT Trust Manager* from the switcher icon at the top right corner. 3. From the navigation panel, select **Enrollment configurations**. The *Enrollment profiles* page opens. 4. Click the desired **Enrollment profile name**. The *Enrollment profile details* page appears. **Note:** 1\. For this use case, the enrollment profile is already created. See [Create an enrollment profile](https://docs.digicert.com/en/iot-trust-manager/enrollment-profiles/create-enrollment-profiles/create-an-enrollment-profile.html) to learn more. 2\. Set up the enrollment profile method for REST API, as it is the integrated method with Litmus Edge Manager. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0_-JVj8Bz-mOG1qsASbjr_image.png" size="60" width="771" height="458" position="center" caption="Certificate enrollment methods dialog box" showCaption="true"} ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/UNVpEkSuSgUHShwUnahJU_image.png "Enrollment profiles page") 5. Configure the keypair generation settings to be used. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/qMr3rarFgo9vS1zmp3wY2_image.png" size="60" width="690" height="324" position="center" caption="Keypair generation settings" showCaption="true"} 6. After creating the Enrollment Profile, edit the enrollment profile. Scroll to the bottom of the Enrollment Profile details page and create a passcode. Copy and save this passcode to a secure location. See also [Enrollment Passcodes](https://docs.digicert.com/en/iot-trust-manager/enrollment-passcodes.html) to generate the passcode for authenticating to the REST API. 7. You can retrieve the *URL*, *Profile ID*, and *Passcode* parameters from the *Enrollment profile details* page as follows: - **URL:** This is the DigiCert server URL. Navigate to *API *section and copy **Request URL** link. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/y7za2LNooaM6FjE6gUfdS_image.png "Enrollment profile details page - API section") - **Profile ID: **Copy this from the *Enrollment profile ID*. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/xtJeJ4zAPemP3eAdzaUwr_image.png "Enrollment profile details page") - **Passcode:** This was generated and shown when you created the passcode above. 8. Enter the retrieved parameters into the *DigiCert *Integration fields in the Litmus Edge Manager Admin Console. 9. Click **Save**. A confirmation message will appear indicating that the DigiCert settings are saved. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/OCv2nla0_iZHk2KAKrFoZ_image.png" size="80" width="1472" height="1318" position="center" caption="DigiCert Integration Page" showCaption="true"} # Step 3: Set up Certificate Authority for Litmus Edge Manager **To set up the certificate authority for Litmus Edge Manager:** 1. From the Litmus Edge Manager Admin Console, navigate to **Settings **>** Domain/SSL**. 2. From the *SSL settings* panel, choose the **DigiCert **option. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/N7YsiL41qOa36WfyIqH6k_image.png "Domain/SSL Settings Page") 3. Click **Save**. 4. The *Page Reload Required* dialog box appears. Click **Yes, **and refresh the page. SSL settings are saved and the page is reloaded after updating the certificate settings for proper system functioning. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3ns5W8acqQlgodf0s-9N7_image.png "Page Reload Required dialog box") # Step 4: Issue a certificate for Litmus Edge from Litmus Edge Manager User UI **To issue a certificate for Litmus Edge device from Litmus Edge Manager User UI:** 1. Log in to Litmus Edge Manager and navigate to **Certificates **tab. The list of current certificates for your edge devices along with their details appears. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/wor5cS1D7MATTjOAUYzuD_image.png "Certificates tab") 2. To issue a new certificate, click the **Action **button for an edge device and select** Issue a new certificate**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/GGqFNZ4h6Usw-8rHlAT6-_image.png "Certificates Management pane") 3. From the *Issue a new certificate *dialog box, configure the following: - **Certificate Authority:** From the dropdown menu, select **DigiCert IoT Trust Manager **as the new certificate authority. - (Optional) Keep default settings for the other fields. 4. Click **ISSUE CERTIFICATE**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/xPkOg_15fwsV_wEmMcPSi_image.png" size="60" width="539" height="513" position="center" caption="Issue a new certificate dialog box" showCaption="true"} The certificate has been added to the Litmus Edge device along with the issuer details. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1xbvMltid-RiwVldShWP2_image.png "Certificates tab") # Step 5: Verify Certificate for Litmus Edge Device **To verify that the certificate has been added to the Litmus Edge device:** 1. Navigate to the specific edge device instance where you applied the certificate and log in. 2. Go to **Systems **> **Network **and find the *Device Certificates* panel. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/_zwi_rodp7M3kokbX3fqJ_image.png "Systems > Network page") You can verify the certificate details and ensure that the new certificate has been added. :::hint{type="info"} **Note:** Refresh the screen if necessary to see the updated certificate and issuer details. Reboot is required to see the certificate update on browser tab. ::: [title] Litmus Edge Manager 2.26.1 [path] Product Updates/2025/ Release Date: May 21, 2025 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## New Features | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Zerotouch Activation:**
* You can now manage *Zerotouch *configurations, generate and download *ZT bundles*, with logging for all actions. - Supports only public Docker registries in initial release. * You can now enable the **Default Router** checkbox in the *Static IP *section of *the Add Zerotouch Configuration *dialog box when configuring static gateways. | | **Edge Device Metrics Sync Interval:**
* You can now configure the Litmus Edge metrics sync interval via project, instance and edge devicesettings. | | **Asset Management:**
* Enhancements have been made to **Asset Management**, including Digital Twin model synchronization, model versioning, upgrade capabilities for linked instances. | | **Daily Digest:**
* Litmus Edge Manager now includes a feature to send periodic notification updates with key statistics on Edge devices. | | **Site License Allocation:**
* The new License Allocation tab enables the distribution of licensed data points from a single site license across multiple projects. | ## Enhancements and Improvements | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Web UI:**
* Litmus Edge Manager Web User Interface and Admin Console now feature a newly adopted branding for the login page. | | **Activation:**
* The activation configuration now has the option to provision *AWS IoT SiteWise *connector during activation. * You have updated list of activation requests that includes an optimized summary of all action items. * You will see modified *Activation Stage *error messages with the stage name included. | | **Digital Twins:**
* The following data types are supported for Static Attributes: - Supports the import and export of attributes in a CSV file. - Displays the total count of added attributes. * The following data types are supported for *Dynamic Attributes*: - JSON - String - Number - Boolean - Array * The *Hierarchy* is renamed to **Schema**. * Youhave versioning support, and the Digital Twins model version is displayed next to the model name. * You have support for *JSONata* scheme types in transformations, allowing for flexibility in data manipulation operations and improved integration with complex data structures. * Asset management configurations are now part of Litmus Edge Manager backup. * Static and dynamic attributes can now support up to 2,000 attributes. * Digital twin events are now accessible through the web interface. * The model name can only include the following characters: uppercase and lowercase letters (A-Z, a-z), numbers (0-9), hyphens, and underscores. | | **Applications:**
* Marketplace applications updates now ensure the old version remains active until the new version is fully downloaded before stopping the existing container. * The **Publisher **name column is added to the *Applications *table. | | **Central Certificate Management:**
* You can now bulk deploy renewal certificates to edge devices. * You can set up notifications through alerts for expired certificates. | | **Central AI/ML Model Management: **
* The Edge device status is now visible on AI/ML model list page for better insight before applying models. | | **Alerts:**
* You will now receive updated *Webhook* alerts in JSON format. * You now have updated *PagerDuty* trigger action field within the *Edit Action *dialog box. * The email content for Alerts is updated to show device status changes. It will now display **CONNECTED** when online and **DISCONNECTED **when offline. * You can now set up alerts for expiring API tokens, which will notify you of the token details and the number of days until expiration. - This can be configured using a new option available called instance metrics within the trigger settings. | | **Marketplace Catalog:**
* You will see detailed error messages providing necessary information in the *Marketplace Catalog* backend errors occur. * You will now see the user name associated with each event displayed below its message. * You can upgrade the public marketplace catalog to support new market catalog apps. * You can navigate between the *Catalog *and *Events *pages using a new dropdown section. * You can track events in the *Marketplace Catalog*, including actions for catalogs, applications, registries, and releases. * You can encounter an `unexpected compose error` during release submission due to parsing issues in configuration settings. * The submitted release tiles now display a timestamp in **UTC **format. * You have the *Publisher Name* field (up to 64 characters) in the application card tile and application page. | | **Settings:**
* You will be prompted with a *Removal Confirmation* dialog box before deleting the upgrade file. * You can now use the updated backup feature for the Litmus Edge Manager: - API and CI/CD integration - Bulk deletion of backup files stored**** | ## Resolved Issues | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **User Interface:**
* Fixed issue with long company and project names overlapping with the edit button on the project tile. | | **Central Licenses Management:**
* Fixed issue with *License Summary* page, where the **back** navigation from an individual device routes to the Edge Devices page instead of the expected Central License Management landing page. | | **DeviceHub:**
* Fixed issue where *INCIDENT RESOLVED* alerts were incorrectly triggered due to disrupted MQTT connections. | | **Applications:**
* Fixed issue where Prometheus consumed excessive memory in certain deployments. | | **Alerts:**
* Fixed issue where *Incident Record *now displays when a new trigger and severity are set to info. | | **Events:**
* Fixed issue where admin token creation event displayed incorrect name and inaccurate expiration. * Fixed issue where the **INCIDENT RESOLVED** alert occassionally triggered inaccurately when the MQTT connection was lost, producing a misleading alert status. | | **Grafana Dashboard:**
* Fixed issue where the friendly name was not displayed in the Grafana dashboard dropdown. | | **Cloud Management:**
* Fixed issue where an incorrect delete icon displayed in the action menu in **Cloud Management** > **Types**. | | **Edge Management:**
* Fixed issue where newly added child devices may not have appeared in the device list after upgrading, and *Metrics Sync *status did not update as expected.
**Templates:**
* No notification appears when creating a template from a Litmus Edge device with a trial license. | | **Security:**
* Updated the Alpine version to the latest release. * Resolved the following vulnerabilities: - CVE-2024-38821 - CVE-2016-1000027 - CVE-2025-24813 - CVE-2024-24790 - CVE-2024-24790 - CVE-2024-40896 | | **Support:**
* Fixed issue with syslog message size limit causing exceptions. * Fixed issue where changing SSL settings in the Admin Console triggered an unknown Http failure response error when saving. | ## Deprecated Components and Features | Description | | ------------------------------------------------------------------------------- | | **Edge Devices:**
* The *Data *tab has been removed from the UI. | # Available with AWS, Azure, K8s Deployment ## What's New ? | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Litmus Edge Manager on K8S:**
* Litmus Edge Manager now supports deployment and management on Kubernetes. | | **Litmus Edge Manager AWS Marketplace Listing:**
* Litmus Edge Manager is now available as a cloud-hosted AWS application, offering AWS users a consumption-based, pay-as-you-go model. | ## Enhancements and Improvements | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Azure and AWS deployed LEM Dashboard Overview:**
* LEM dashboard shows tags consumption and provides the CSV report including all License clients. | [title] Browser Issues [path] Troubleshooting/ The following sections describe common browser-related technical difficulties may occur when trying to access Litmus Edge and how troubleshoot them. The difficulties that may arise includes the following: - Browser Access Restrictions - Browser Cache Issues # Browser Access Restrictions Browsers typically display one of the following two warnings when trying to access Litmus Edge: - Your connection is not private - You connection is not secure Litmus Edge uses self-signed certificates by default. This type of warning is expected when using a self-signed certificate in a local environment. You can bypass browser warnings on Google Chrome and Mozilla Firefox as follows: - **Google Chrome**: Click **Advanced**, and then click **Proceed to \ (unsafe)** at the bottom of the page. - **Mozilla Firefox**: Click **Advanced**, and then click **Add Exception...** at the bottom of the page. Click **Confirm Security Exception** on the pop-up window The following table details some of the reasons for browser access restrictions and recommended steps to resolve the issues. | **Possible Causes** | **Recommended Steps** | | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Needs SSL Certificate from trusted authority | Litmus Edge includes a self-signed certificate, but you can add additional certificates. See [Certificates](docId\:s0dXZeU8mTAywyQsYEDyj) for more information. | | Wrong date and time on computer/device | Verify that the date and time are correct on the device. | | Browser cookies and cached files | This usually only occurs in the Chrome browser. Clear the cookies and cache. | | Anti-virus software block SSL connection | Try disabling the anti-virus software. | | DNS caching | Clear the DNS cache using the ipconfig command in Windows:
`ipconfig `/ `flushdns` | | Owner has configured website improperly | This usually only occurs in the Firefox browser. Add the Litmus Edge IP address to the browser's website exceptions list to proceed. | # Browser Cache Issues Litmus Edge and Litmus Edge Manager applications use a web browser as their main interface. For optimized loading, web browsers keep a cache of files and images for recently visited websites. This avoids having to download the pages each time you visit a page. This optimization can sometimes cause problems when the browser reads from its cache instead of downloading the latest page. This can cause unexpected behavior such as the following: - The page looks partially loaded. - The page looks like it has loaded but the page has strange or unusual formatting. - Images on the page are in the wrong places. - Strange login and license activation issues. ## Clear the Browser Cache You can easily fix cache issues by clearing the cache. Here are some easy ways to clear a browser’s cache. These techniques should work on all Windows and Mac browsers. - Hold down the** SHIFT key while refreshing the page**. This forces a refresh with an empty cache on all browsers. - Press the **CTRL + SHIFT + R** key combination to force an empty cache refresh. For **Safari**, press **CMD + R**. - Hold the** CTRL + SHIFT + DELETE** key combination to open the clear browser history menu. For **Safari**, press **CMD + SHIFT + DELETE**. Make sure to choose the cache option and the largest time range possible to clear the entire cache. ## View and Clear Browser History Often, clearing the browser history can help fix issues. Press **CTRL + H** to view the history menu. You can clear the browsing data from this window or select a previous page from the list. For Safari, press **CMD +H** key combination to view the history menu. [title] Litmus Edge Manager 2.31.3 [path] Product Updates/2026/ Release Date: May 6, 2026 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Enhancements and Improvements | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Asset Management:**
* Dynamic attribute data types are now consistently stored and displayed in lowercase in the database and APIs. Existing models with inconsistent data type casing are automatically migrated. Backend validation now enforces correct data type values when saving models. | ## Resolved Issues | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Asset Management:**
* Fixed issue where a new model update could not be applied from Litmus Edge Manager to a Litmus Edge device even though an older version of the model was deployed on the device. | | **System:**
* Addressed vulnerabilities in third party components. | [title] Generate and Manage Daily Digest [path] How-To Guides/Litmus Edge Manager Admin Console Guides/ You can set up regular email updates to monitor the performance of your Litmus Edge. These daily digests will provide insights into PLC or any device connected with the driver. # Before You Begin - Ensure to set up your SMTP [Email](docId\:GcxRXKR3-oc_O9zqz7Jke) settings in Litmus Edge Manager for the emails to be sent. If these settings are not configured correctly, a warning message will appear. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Ul_PW_ihdBw6P7hRR5Flz_image.png" size="68" width="1252" height="600" position="center" showCaption="false"} - Read more about the list of information you can choose to send in email [Reports](docId:5aRrj1KnuwljUxwWG5GZZ) in Litmus Edge Manager. # Email Report Contents The email reports will include the performance statistics you choose from the *Report *section in your *Admin Console *settings. Here is a sample of the **Report** with key sections included: :::hint{type="info"} **Note: **The date and time of the report's generation will be displayed in the email report. ::: ::File{src="https://archbee-doc-uploads.s3.amazonaws.com/Q116WJTAr1sefeVNvMCF9-qyDzCclzdRebBATJGqo_e-20250409-200424.pdf" label="Litmus Email.pdf"} # Step 1: Access Report Settings To find the settings, follow these steps: 1. Navigate to **Litmus Edge Manager Admin Console**. 2. Go to **Settings** > **Reports** section from the left menu. 3. In the *Reports* section, you will see options for **Daily digest settings** and **Subscription.** ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/8hbiyllLozzwVkpatBZs2_image.png) # Step 2: Manage Report Subscribers The **Subscription **section lets you manage who will receive the email. 1. You can **Filter **the list of subscribers to find specific ones. 2. To add a new subscriber, click the **"+" **icon. - The *Add Subscriber* dialog box appears where you need to enter the **Subscriber Name** and **Subscriber Email**. - Then click **Add**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/s3Nweazysqw8xHlUeuWWl_image.png" size="40" width="355" height="231" position="center" showCaption="false"} 3. To refresh the list of subscribers, click the **Refresh **icon. * * 4. In the **Action **column (three dots), you have the following options: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/rvTkv2LVYW1KepCgsKDS2_image.png" size="40" width="313" height="341" position="center" showCaption="false"} - **Edit Subscriber:** To change the name or email address of a subscriber. - **Enable Subscriber: **To include this subscriber in the email reports. The *Status* will show as **Enabled** (in green). - **Disable Subscriber:** To stop this subscriber from receiving email reports. The *Status* will show as **Disabled** (in orange). - **Send Report:** To send an email report to this specific subscriber immediately. - **Delete Subscriber:** To remove this subscriber from the list. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/u8DJKU9YBYIJ-iyalfYzS_image.png) # Step 3: Set Up the Report (Daily Digest) The **Daily digest settings** area is where you choose what information you want to send in your email reports and how often. 1. Turn on the reports by clicking the **Enable Report** toggle. 2. Choose how often you want to receive the reports under **Period Frequency**. You can choose: - **Daily:** You will get a report every day at **00:00:00 ***Coordinated Universal Time (UTC)*. - **Weekly: **You will get a report every **Monday **at **00:00:00 ***UTC*. - **Monthly: **You will get a report on the first day of each month at **00:00:00 ***UTC*. - Note that the specified times are based on the **VM Timezone**, which is typically aligned with *Coordinated Universal Time (UTC)*. 3. You can choose to include all available information in the reports by clicking **Enable All Metrics**. See [Reports](docId:5aRrj1KnuwljUxwWG5GZZ) for the metrics you can choose to send in reports. 4. If you only want specific information, you can turn off *Enable All Metrics* and then select the metrics you want to include. See [Reports](docId:5aRrj1KnuwljUxwWG5GZZ) for the metrics you can choose to send in reports. 5. After selecting the information you want, click **Save** to save your settings. 6. You can also click **Send Report** to send an email report immediately to the subscribers. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/qlhU7lI1xgj2dQU-wr8WD_image.png) :::hint{type="success"} **Important Notes:** - The information in the reports may change based on your data lifecycle policy. - If you are not receiving the email reports, check your spam or junk email folders. - Make sure the subscriber's email address is correct and that the **Status **is *Enabled* for that subscriber. ::: [title] Litmus Edge Manager 2.31.0 [path] Product Updates/2025/ Release Date: December 1, 2025 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## New Features | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Asset Management:**
* This release introduces **Viewer** and **Administrator **asset management roles for Digital Twin functionality in Litmus Edge. Visibility of edge devices is limited to the companies that you have access to. Assign roles in Litmus Edge Manager Admin Console by navigating to **Settings** > **Users**, selecting a user, and scrolling to **Asset Management Roles**. With the new roles: - The **Viewer** role provides view access to Digital Twins. - The **Administrator** role provides full access to Digital Twins. * Now you can define parameters for dynamic attributes in Digital Twin models. In Litmus Edge, users can update parameter values by instance to define the topic for each dynamic attribute. * Edge devices now synchronize automatically when a Digital Twin model is updated. | | **Litmus Edge Manager and Git Integration**
* Now you can connect Litmus Edge Manager with an external version control system (GitHub, GitLab, or Azure DevOps) and store, manage, and track changes to Litmus Edge template files. Configure the integration in the Admin Console in **Integration** > **Git Provider**. | | **AI Chat Agent:**
* Added an AI chat agent that enables asking questions in natural language based on daily digest report data. For example, ask 'How many edge devices are online' or 'What's the current disk usage and available space'. | ## Enhancements and Improvements | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Devices:**
* LEM now displays a warning banner when disk space is low and pauses the ingestion of new messages. Previously, notifications only displayed in LEM Admin Console. * LEM now provides better handling and error messaging during image uploads when disk space is low. | | **Applications:**
* You can now export Marketplace catalogs that belong to specific companies. | | **Events:**
* System events are now available in the Admin Console. Now you can filter and view both general and project-specific system events. * Additional LEM and LE events are now available in **Company** > **Events**. This includes System , Licensing , Digital Twins, Cloud Storage , Analytics , Flows , and DataHub event information. | | **Alerts:**
* Now the name of the trigger that you define displays in the **Trigger** column in **Alerts** > **Incidents **instead of the trigger ID. The helps you easily identify the trigger that caused the incident or alert. | | **Settings:**
* Now you can bypass strict certificate validation for SMTP servers with a new checkbox in **Settings** > **Email **> **Email Settings**. Enable to specify a mail server as trusted when the server uses a self-signed or custom certificate. | | **Keycloak:**
* Admin users now display in the Admin Console UI when they are members of a team in **Settings** > **Users** > **Members**. | | **SSL Certificates:**
* Error handling is improved for invalid root CA certificates. Now an error message displays in **Settings** > **Domain/SSL** > **SSL settings** when adding a valid SSL certificate and a key file with an invalid root CA certificate file under **User Defined**. | | **Licenses:**
* Central License Management now displays an **Edge Device Status** (Online or Offline). | | **LEM Backups:**
* Backups are now compatible between Litmus Edge Manager virtual machines and Kubernetes deployments. Note that backups must be performed from the same LEM version. | | **UI:**
* Now the displays company name instead of company code in various locations in the Admin Console. | | **Application Parameters:**
* You can now view the parameters that were enabled when an edge device was deployed in **App Parameters** on the **Application Details** page. | | **Project Webhook Notifications:**
* Administrators can now set up a webhook notifications when a project is created, updated, or deleted. Setup notifications in **Alerts** > **Triggers** in Litmus Edge Manager Admin Console. | | **Docker Compose:**
* You can now specify a custom network name in your Docker Compose file. If the network exists, existing containers will join it. Otherwise, the network is automatically created to enable communication across mutliple Compose applications. | | **Linux Alpine:**
* Alpine has been upgraded to version 3.2.1. | ## Resolved Issues | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Events:**
* Fixed issue where a **INCIDENT RESOLVED** alert was inaccurately triggered when the MQTT connection was lost, which mislead users regarding alert status. * Fixed an issue where a `500:Internal Server Error` occasionally occurred when accessing **Events**. | | **Settings:**
* Now `https` is enforced for Keycloak admin console redirects. * Fixed an issue where the system attempted to authenticate to an STMP server when the **Use authentication** checkbox was unselected in **Settings** > **Email **> **Email Settings**. | | **Security:**
* Fixed issues with upstream security vulnerabilities. * Fixed access issue with Keycloak admin role for Project Level Teams list. * Resolved a CVE-2024-38821 vulnerability. | | **Cloud Management:**
* Corrected the delete icon that displayed in the *action menu* in **Cloud Management** > **Types **section. | | **Company/Project List:**
* Fixed issue where the company list did not always automatically refresh after adding new companies. * Fixed issue where long company and project names (over 50 characters) always displayed fully in the Admin UI. | | **Dashboard:**
* Fixed display issue where lengthy company and project names caused horizontal scrolling in the UI on smaller screens. | | **Asset Management:**
* Fixed display issue where lengthy company and project names in the Digital Twin UI overlapped with edit buttons on the project tile. | | **Applications:**
* Fixed issue where an error prevented saving of component details after correcting initial input errors in Marketplace. * Fixed issue with inaccurate counts of deactivated Edge Devices in total devices in the **Application **table. | | **System:**
* Fixed issue where changing and saving SSL settings in the Admin Console could trigger an unknown error Http failure response. * Fixed an issue where a `Site-Based license server is provisioned to the device. Error `occurred when activating LE against LEM with a site license configuration. In this case no clients were created in LEM. * Fixed issue where a `Failed to check firmware upgrade status. Max retry attempts exceeded` error displays in Litmus Edge Manager after upgrading a Litmus Edge device, even when the device was upgraded successfully. * Fixed issue where the device name was occasionally excluded from messages and email notifications that indicated that the license has expired for a device. | | **Performance:**
* Fixed performance issue that occurred when refreshing a Company list that contained a large number of companies. * Fixed issue where long company and project names (over 50 characters) in Company list did not display fully. | [title] Deploy Digital Twin Models to Edge Devices [path] How-To Guides/Litmus Edge Manager User UI Guides/ After a Digital Twin Model is completely configured, you may deploy it to Litmus Edge devices. # Step 1: Select Models You can select the models that will be deployed to recipient Edge Devices. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/wnzq6c5un5WVZ9eGj4ABO_image.png" size="80" width="1142" height="482" caption="Step 1: Select Models" position="center" showCaption="true"} **To select the digital twin model**: 1. From the *Models *tab, select at least one model to deploy. 2. Click **Next**. # Step 2: Select Edge Devices After selecting models that will be deployed to Edge Devices, select the devices that will receive the model. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/OgtGC73b5yU4UomzE2EZV_image.png" size="80" width="1119" height="444" caption="Step 2: Select Edge devices" position="center" showCaption="true"} **To select edge device to deploy to**: 1. From the *Devices *tab, select one or more edge devices from the edge device list. 2. Click **Next**. # Step 3: Preview and Deploy Before deploying digital twin models to a list of Edge Devices, you can preview details before they get deployed. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0Dey5EighcALdHgTvBM88_image.png" size="80" width="1535" height="668" caption="Step 3: Preview" position="center" showCaption="true"} **To preview and deploy**: 1. From the *Preview *tab, review the details of the *Device(s)* and *Models(s).* 2. Click **Deploy.** # Step 4: Result You can view the results of deploying digital twin models to verify if the deployment was successful or not. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/IjW1mNXFf4GdCO5K3eibv_image.png" size="80" width="1127" height="411" caption="Step 4: Result" position="center" showCaption="true"} **To view results**: 1. From the *Result *tab, view the deployment details. See below *Status* to confirm whether a deployment was successful or not. 2. (Optional) Click on a Edge Device ID to view more information about that particular Edge device. 3. Click **Close** to finish deployment. # Next Steps See Litmus Edge's [Digital Twins](docId\:i-2A7b3AB6vuvkqfhLjgX) on what can be done with deployed Digital Twin Models. [title] Litmus Edge Manager 2.2.2 [path] Product Updates/2021/ Release Date: September 30, 2021 ## Enhancements and Features The following features and enhancements are included in this software release: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Edge Remote Networks:**
* Enables remote access to edge devices | | **Licenses:**
* Added support for floating license deployment during activation provision * Included floating license server with Litmus Edge Manager | | - Added support to add variable value sets for provisioning activation configuration - Added support to upload variable value set from a `.csv` file - Added support to apply variable value set to either all edge devices or to selected edge devices based on hostname connected edge devices | | **Templates:**
- Analytics is now supported in templates | | **Component Enhancements:**
- Updated GCR registry with hostname field - Updated Marketplace Catalog Name - Updated date format in edge devices software jobs | | **UI / UX Improvements:**
- Updated feature names and added with experimental features | ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ------------------------------------------------------------------------------------------------------------- | | - Fixed issue with license monitoring causing connection leak. - Added fix for self-signed certificate issue. | ## Known Issues The following issues are unresolved in this release: | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | - Parametrized templates are not supported for instance level templates - Admin Dashboard usage stats inconsistent to Data Lifecycle Management statistics | [title] Litmus Edge Manager 2.5.3 [path] Product Updates/2022/ Release Date: November 18, 2022 ## Enhancements and Features The following features and enhancements are included in this software release: | **Description** | | ------------------------------------------------------------------------------------------- | | **Admin Console:**
* If a login attempt is unsuccessful, a 3 second delay will be set. | ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Marketplace: **
* Fixed issue with importing (uploading) private applications to a catalog.

**Features:**
* Gateway details now correctly display activated Litmus Edge devices in the Gateway drop-down menu. | ## Deprecated Components and Features The following components/features will no longer be available: | **Description** | | ---------------------------------------------------------------------------- | | **Company Settings:**
* The OMA Registry tab is no longer offered. | [title] Litmus Edge Manager 1.9.1 [path] Product Updates/2020/ Release Date: November 13, 2020 ## Enhancements and Features The following issues that existed in one or more previous releases have been resolved: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Resolved Issues**
* Fixed issue with licensing module consuming high memory usage * Fixed upgrade issue with LEM-1.8.4 version * Fixed issue with admin-ui chart loading * Updated on UI to allow only upload of json files * Minor fixes to typo in product description | ## Known Issues The following issues are unresolved in this release: | **Description** | | -------------------------------------------------------------------------------------------------------------------------------- | | - Failure on all file upload of Litmus Edge on Litmus Edge Manager Admin Console on FireFox browser with self-signed certificate | [title] Litmus Edge Manager 2.3.1 [path] Product Updates/2022/ Release Date: February 22, 2022 ## Enhancements and Features The following features and enhancements are included in this software release: | **Description** | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Licenses:**
**New - Site-based licenses**: An embedded license server allows you to add a site-base license for edge devices | | **Edge Devices:**
**New - Edge Metrics**: Allows viewing edge device metrics such as the device status, integration status. | | **API Tokens:**
**New - System API Token**: Provision of a read-only system API token upon activation of an edge device | | **Dashboard:**
**New - Statistics**: Includes disk usage by data object | | **UI / UX Improvements:**
* Added support resources to user menu: - User Manual - Litmus Support - Litmus University - End-user license agreement * Enabled returning to the last module used in a company or project upon a user login * The "Marketplace Catalog" tile label is changed to "Marketplace" | ## Known Issues The following issues are unresolved in this release: | **Description** | | ---------------------------------------------------------------------------------------------- | | Parametrized templates are not supported for instance-level templates | | The Admin Dashboard usage stats are inconsistent with the Data Lifecycle Management statistics | [title] Litmus Edge Manager 2.22.2 [path] Product Updates/2024/ :::hint{type="warning"} **Important**: For a seamless upgrade experience in upcoming releases, it's crucial to upgrade from version 2.16.4 to 2.22.2 before making any further upgrades. Skipping the initial upgrade to version 2.16.4 and then 2.22.2 may disrupt the upgrade process, and is therefore not recommended. ::: Release Date: Sept 25, 2024 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## New Features | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Central Certificate Management:**
* The *Certificates *page has been updated to manage **SSL Certificates** on Edge Devices. The page includes combined menu items, sorting and filtering options, menu actions, as well as logging and monitoring features. * The* Certificate action* tab includes three actions: - Issue a new certificate - Upload a new certificate - Reset to Edge default certificate * The periodic certificate expiry check and renewal process for Edge devices is now available. | | **Central AI/ML Model Management: **
* The main homepage now features a new user interface for central management of **AI/ML Models**, including summary statistics to provide a comprehensive understanding of the usage of AI/ML Models within Litmus Edge. | | **DigiCert IoT Trust Manager integration:**
* The **DigiCert IoT Trust Manager** integration is now available from the admin console. | | **Central Licenses Management:**
* The *License *management homepage now features a new user interface with summary statistics, providing a comprehensive understanding of key usage within Litmus Edge Manager. * The *License *management page allows users to monitor and manage the expiration status of features and core licenses for edge devices within the current project. | | **Edge Devices:**
* The Edge Devices page in Admin Console now includes a new menu item for **Node-Locked (NL) Licenses**. This feature displays a list of all NL licenses used across all projects and allows you to download the list as a *CSV *file. | | **Alerts:**
* The *Incidents *option is now accessible under the *Alerts *page, allowing you to effortlessly configure triggers and send notifications. | | **Activation:**
* The *Activation *>* Requests* page displays an optimized summary of the activation requests and their respective statuses, including Total, Waiting for Approval, Processing, Processed, and Failed. * The template variables now have a new drop-down selection menu for the variable name field, allowing users to select from the list of all the variables defined in the parameterized templates in the activation configuration. | ## Enhancements and Improvements | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Admin Console Cloud Settings**:
* In *Cloud *settings: - When configuring *Cloud Credentials*, you now have the option of configuring GCP Workload Identity Federation (OIDC) for authorization. - During account service key rotation, mpc-sync service account keys are also rotated as well. * In *Domain/SSL* settings, the SSL Settings log now displays more information for update operations in SSL settings. * In *Email *settings, when the Enable SMTP toggle is disabled, any existing SMTP settings are now removed. | | **Data Lifecycle**:
* The *Statistics *page now has enhanced disk partition usage visualization, a comprehensive partition list, a new pie chart for improved data representation, and an expanded object list. | | **Edge Devices:**
* The **Description **column is added to the edge device list in admin console. * When the Litmus Edge Manager base-domain name is updated, respective activation URLs for Edge devices are automatically updated based on the new domain name. * Upgrades are now restricted to VM-based Edge devices. Upgrades on Docker-based Edge devices are not allowed. * The limit for the activation endpoint of 10 rps (requests per second) is now removed, allowing for more Edge devices to be processed at one time. * The error message now contains the Activation config code and correct template name during failed activations with a template. * Added logging for the deactivation process for an edge device in the *API actions* log. | | **Templates**:
* The **Templates **module for Edge devices are now included in Litmus Edge Manager backups. If a Litmus Edge Manager backup is restored, Edge device templates are also restored. * The template names must be unique and cannot be duplicated. | | **DLM Actions:**
* The Purge action can now be used to archive and delete Clickhouse table data. | | **Alerts & Triggers:**
* The alert for DeviceHub device offline status has been updated to exclude stopped DeviceHub devices from generating Offline Device alerts. * The Litmus Edge Manager now supports triggering alerts with severity set to `Info`. | | **Keycloak:**
* Upgraded keycloak to `24.0.5`. | | **User Interface:**
* The *Company list* page onlog-inn now displays the number of connected edge devices for each company. | | **Certificates:**
* The *Issue a new certificate* dialog box has a new Certificate Authority field, which includes `Litmus Edge Manager` and `DigiCert IoT Trust Manager` as selectable values for certificate issuance. | | **Marketplace:**
* The marketplace catalog's API can be accessed by third-party applications using tokens authorized by Litmus Edge Manager's admin. | | **Settings:**
* The *CREDENTIALS *page in *Project Settings *has been updated with a new user interface to separately display and download SSL certificate information for MQTT and Web servers. * The** DigiCert IoT Trust** option is available from the *Admin Console Settings* to set the SSL certificates only when the DigiCert integration parameters are configured. | | **Domain/SSL:**
* The *SSL settings* have a new Async task to distribute Litmus Edge Manager's CA certificates to all activated Edge devices. | | **Support:**
* The support bundle has been updated to include docker disk usage information. | | **Software:**
* The title of the *Software *menu under *Projects *has now changed to **Software Update**. | | **Incidents:**
* The *Incidents *now have added support for creating alerts and triggers based on OPC UA telemetry from the Prometheus endpoint. | | **Features:**
* The marketplace catalog app now supports adding fully compliant Docker Compose files to the new application releases. * The device deployment status display has been improved to show the number of devices with the app and the total number of devices (online + offline). Additionally, the help text has been updated, and a subheader has been added to describe the widget's purpose without requiring a hover. | ## Resolved Issues | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Management**:
* Fixed issue with flows dashboard not showing on Remote UI. | | **Security**:
* Various vulnerabilities fixes are addressed in this release. | | **Events & Alerts:**
* Fixed the issue of not being able to set the *Verify SSL* setting to **false**. | | **Software Updates: **
* Fixed issues with upgrades through update files failing because of insufficient disk space. | | **User Interface**:
* Fixed issue with `%` data on the *Disk Usage graph,* partially hiding the number. All data in percentages are displayed in full now. | | **Integration**:
* Fixed issue where the Clickhouse data directory was relocated to the wrong location during an upgrade. | | **Profile:**
* Fixed issue with the Two-factor authentication section that was causing an `Internal server error` when attempting to set up **2FA**. | | **Sites:**
* Fixed issue encountered when attempting to add a site without an image, resulting in an `Error 403`. | | **Applications**:
* Fixed issue with an empty list displaying after filtering the list of applications by catalog. | | **Tokens**:
* Fixed issue with not all associated projects being automatically selected when you select **\[Company name] \[All projects]**. * Fixed issue with the long-term API Admin token not being able to create a new company and returning an error message. | | **DeviceHub**:
* Fixed issue with devicehub drivers parsing and saving payloads with new keys to OMA tables in ClickHouse. * Fixed issue with maximum message size for syslog where messages are now truncated to fit within the limit. | ## Deprecated Components and Features | Description | | ------------------------------------------------------------------------------ | | **Settings**:
* The OMA bindings are no longer available for any project. | [title] Litmus Edge Manager 2.1.0 [path] Product Updates/2021/ Release Date: March 17, 2021 ## Enhancements and Features The following issues that existed in one or more previous releases have been resolved: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **New - Parametrized Template Deployment:**
* Implemented initial phase of parameterized template * Supports attribute value type for string and number
**Note**: This feature is enabled from Litmus Edge Manager Admin Console **Settings** > **Experimental Features**. | | **New - Full Fledged access to Litmus Edge UI from Litmus Edge Manager:**
* Litmus Edge Manager supports initial version of full fledged access to Edge UI * Requires authentication on edge device for the first login

**Note**: This feature is enabled from Litmus Edge Manager Admin Console **Settings** > **Experimental Features**. Initial phase of implementation is direct mode and requires an open connection between Litmus Edge Manager and Litmus Edge on port 443/TCP. | | **New - Added a system trigger to monitor device status:**
* Based on raw topic value for PLC status, system trigger can be set for alert and notification * Extended system trigger scope to all
**Note**: This system trigger is currently based on success value on RAW topic. | | **New - Support for RAW topic directly on Litmus Edge Manager:**
* Litmus Edge Manager supports RAW topic from Edge Device which helps in easy access with child device on Litmus Edge Manager | | **UI/UX Improvements:**
* Improved input fields for password throughout the system | | **Other Component Enhancements:**
* Extended capability of device management with different versions of Edge Devices | ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | - Fixed issue with proxy setting configurations not being saved - Fixed occasional sync up issue with active Edge Device count on license page - Fixed issue with ZT node for remote access - Fixed issue with alert notifications not being sent continuously | ## Deprecated Component The following components/features will no longer be available: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | - Deprecated V1 activation, starting 2.6.x all Edge Device versions support V2 activation - Export/Import feature in Litmus Edge Manager Admin console due to known issue, this will be improved and added in upcoming release | ## Known Issues The following issues are unresolved in this release: | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | - Failure on all file upload of Litmus Edge on Litmus Edge Manager Admin Console on FireFox browser with self-signed certificate - Parametrized templates are not supported for instance level templates - DLM archive/purge doesn’t affect on the current time period (current month) - Admin Dashboard usage stats inconsistent to DLM statistics - Analytics templates are not supported | [title] Litmus Edge Manager 2.31.1 [path] Product Updates/2026/ Release Date: January 23, 2026 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Enhancements and Improvements | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | | **Integration:**
* For Git integrations, help text now shows the effect of enabling **Track** and **Sync on Backup** for a project. | | **Support Bundle**
* Now you can generate a support bundle file from an ssh session. | ## Resolved Issues | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Security:**
* Addressed vulnerabilities related to Keyclock. * Addressed vulnerabilities in third party components. * Resolved the following vulnerability: - CVE-2025-59952 | | **Applications:**
* Fixed issue where opening Grafana Dashboards from a project failed with a `Failed to sync Grafana organization error`. | # Available with Azure and K8s Deployments ## Resolved Issues | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Litmus Edge Manager on Azure:**
* Addressed vulnerabilities in third party components.
**Litmus Edge Manager on K8s:**
* The Grafana Role now longer displays when editing a user in **Settings** > **Users** in the Admin Console. * Addressed vulnerabilities in Marketplace listing. * Increased Kafka and Zookeeper StatefulSet’s memory limit to accommodate the configured JVM heap size and prevent periodic OOM-related pod restarts. | [title] Litmus Edge Manager 2.31.5 [path] Product Updates/2026/ Release Date: July 3, 2026 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Enhancements and Improvements | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Applications:**
* Marketplace applications now display a `Degraded` status to identify issues with running applications. Degraded status displays when an application is running and one or more containers have exited. | | **Digital Twins:**
* Litmus Edge Manager now enforces the same Digital Twin model validation rules as Litmus Edge and rejects models with whitespace in the model name, special characters in unit fields, or empty parameter values. This prevents deployment failures caused by models that pass LEM validation but are rejected by Litmus Edge. | | **Integration:**
* The **AI Assistant** has been renamed to **Litmus IQ** across the Admin Console and User UI including menu labels, page titles, and toast messages. | ## Resolved Issues | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Applications:**
* Fixed issue where the Application Details page displayed a `"Failed to load release list"` error when at least one release of the application did not have a submission date. * Fixed issue where private variables were visible in the UI when an application launched. Private integer variables are now masked. | | **Projects:**
* Fixed issue where the Project Credentials and Project Settings pages displayed a `"Could not parse certificate"` error if the CA certificate failed to load at service startup. The certificate is now fetched again and a service restart is not required. | | **Edge Devices:**
* Fixed edge device provisioning failure that required a Litmus Edge Manager restart due to stale API token validation after device deactivation and factory reset cycles. * Fixed issue where a backup from Litmus Edge to Litmus Edge Manager failed with a `409 couldn't upload backup: couldn't get upload URL: unexpected response` error. * Fixed backup failures after LEM upgrade caused by Vault raft startup timing issue. * Fixed issue where deprovisioning an edge device failed with an internal error caused by duplicate license records. Duplicate records are now cleaned up automatically. | | **Licensing:**
* Fixed issue where license activation failed during cloud activation for Litmus Edge devices and devices were not correctly provisioned in Litmus Edge Manager. | | **Software Update:**
* Fixed issue where uploading a software update file via URL or downloaded file failed in the Admin Console. | | **Alerts:**
* Fixed issue where an alert sent repeated notifications when an edge device was disconnected instead of once. * Fixed issue where the Incidents page failed to load when a database query exceeded the memory limit on large datasets. | | **Applications:**
* Fixed issue where an exception occurred when a Marketplace application reported an unrecognized status including `Degraded`. | | **Admin Console Settings:**
* Fixed issue where manual and automatic backups could not be performed after upgrading to 2.31.x. * Fixed issue where the user details page in the Admin Console failed to load and displayed an `"Internal error"` notification. * Fixed issue where the static IP address configured on a network interface did not persist after a system reboot and reverted to the default DHCP configuration. | | **System:**
* Fixed issue where a background update caused an `Application is initializing` screen to display when deploying Litmus Edge Manager on Azure. * Fixed issue where Litmus Edge Manager became stuck in the initializing state. * Fixed issue on Kubernetes deployments where MySQL logs filled disk space and caused LEM services to fail. * Resolved the following vulnerabilities: - CVE-2026-48059 - CVE-2026-47691 - CVE-2026-45674 - CVE-2026-45447 - CVE-2026-45416 - CVE-2026-44893 - CVE-2026-44249 - CVE-2026-42583 - CVE-2026-42579 - CVE-2026-42577 - CVE-2026-40973 - CVE-2026-39852 - CVE-2026-27135 - CVE-2026-5598 | | **Docker Registry:**
* Fixed issue where Litmus Edge Manager failed to validate and add a Docker registry when **Docker Skip TLS Verification** was enabled even though valid credentials were provided. | [title] Litmus Edge Manager 2.8.2 [path] Product Updates/2023/ Release Date: February 27, 2023 ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Device Details**:
* Fixed an issue where edge devices were incorrectly displaying `No active license` even though the edge device did have an actual license. | | **Security:**
* Resolved an OpenSSL vulnerability related to CVE-2023-0286 | ## Known Issues The following issues are unresolved in this release: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------ | | **Marketplace:**
* Site license with catalog feature may not enable the *Marketplace* feature and the *Application* page. | | **Upgrade:**
* After a Litmus Edge Manager is upgraded to 2.8.2, connected edge devices may display as offline. | [title] About MQTT [path] Resources/ **Message Queue Telemetry Transport (MQTT) **is a publish/subscribe-based lightweight protocol. It is designed for Machine to Machine (M2M) telemetry in low-bandwidth environments. MQTT sits on top of the TCP/IP protocol. This publish/subscribe protocol requires a message broker. The broker distributes messages to the interested clients based on the topic of the message. **MQTT **defines methods for the desired action to be performed on the client. The different methods are: - **Connect**: Waits for a connection to be established with the server. - **Disconnect**: Waits for the MQTT client to finish the work and then for the TCP/IP session to disconnect. - **Subscribe**: Waits for the completion of a subscribe or unsubscribe method. - **Unsubscribe**: It request the server to unsubscribe the client from one or more topic. - **Publish**: This method immediately returns to the application thread after passing the request to the MQTT client. A **MQTT client **is a sensor that generally publishes messages to the broker. The broker sends the message to the MQTT clients that have subscribed to receive the data. :::hint{type="info"} **NOTE**: A MQTT client can publish, subscribe, or both. ::: A **Client Agent **is available in almost all programming languages and major operating systems. **Topics **are used for MQTT addressing. The JSON file that is downloaded from the Loop platform (when the device is deployed) contains the topic to which the data needs to be published and subscribed. The user can also create a custom topic and define to publish or subscribe or both from ACL (Action Control List) under project settings. An **MQTT Broker **is responsible for receiving all messages, filtering them and sending messages to all the subscribed clients. The broker also does the authentication and authorization of the client. The broker is also extensible, which allows integration of custom authentication, authorization, and integration of the clients. The MQTT connection is always between a client and a broker, as no client connects to another client. The client sends a CONNECT message to the broker and broker response with a CONNACK and the status. Once the connection is established, the broker keeps it open as long as the client does not send a disconnect command. A **Client ID **it is the identifier for each of the MQTT clients that connects to the MQTT broker. The ID is unique per broker. The broker identifies the client and the state of the client using the client ID. **Security**: The broker has a username and password for authentication of the client and authorization. MQTTS also uses TLS/SSL certificates for authentication. **QOS**: The Quality of Service tells the user regarding the guarantee of message delivery. - QOS 0 - At most once. - QOS 1 - At least once. - QOS 2 - Exactly once. The Quality of Service is important as it lets the client choose the QoS level based on the application and network reliability. Alternate protocols include the AMQP (Advanced Message Queuing Protocol), COAP (Constrained Application Protocol), and XMPP (Extensible Messaging and Presence Protocol). [title] Site and Node-Locked License Overview for Litmus Edge Manager [path] Resources/ For a Litmus Edge Manager instance to be able to fully access all features, it must carry a license. This license can be a site license or a node-locked license. For information about Litmus Edge licenses, see [Site and Node-Locked License Overview for Litmus Edge](docId\:nbX0O6C5ylSh-qVy0sdJc). # Understanding and Adding a Site License for Litmus Edge Manager Litmus Edge Manager contains a license server that must be added with a site license. Unlike Litmus Edge, a Litmus Edge Manager must use the site license within its own embedded license server to access all features. The Litmus Edge Manager cannot use a standalone license server's site license. A site license, depending on its constituent features, may act both as a Litmus Edge site license and also a Litmus Edge Manager site license. To add a site license to Litmus Edge Manager, add it in [License Server Management](docId:5U_hNNsaVs--E5HQJEQ0O). To set Litmus Edge Manager to use the added site license, see [Admin Console Licenses](docId\:dMpF2PJbBM7kQQgs0lVUC). :::hint{type="warning"} **Note:** Once a site license is activated, the user must choose the license type; otherwise, the site license will not be applied. This selection can be made in **Settings** > **License **> **License Settings**. ::: # Understanding and Adding a Node-Locked License for Litmus Edge Manager For a Litmus Edge Manager to carry a node-locked license, you will need a license key. The key will be a 16-digit code (`####-####-####-####`) that is valid for certain number of years, based on the license SKU definition. The node-locked license key can be requested from Litmus account executives. A Litmus Edge Manager node-locked license key cannot be used as a Litmus Edge node-locked license key. To add a node-locked license key to the Litmus Edge Manager, see [Admin Console Licenses](docId\:dMpF2PJbBM7kQQgs0lVUC). :::hint{type="warning"} **Important**: Each node-locked license key is bound to a Litmus Edge Manager MAC address. If the MAC address is changed, the license key will be invalidated. ::: # Understanding Litmus Edge and Litmus Edge Manager License Differences Both Litmus Edge and Litmus Edge Manager can carry their own node-locked License version. However, a site license's constituent features will determine whether the site license can be used to a Litmus Edge instance, a Litmus Edge Manager instance, or both. ## Litmus Edge Manager Features for Litmus Edge Licenses Litmus Edge Manager also offers features that manage the Litmus Edge site and node-locked licenses. From Litmus Edge Manager, you can do the following: - Monitor the expiration date of Litmus Edge instances. See [Licenses](docId\:Zurp8hVnSYJMgcZ1mceUQ). - Set the initial license status of a Litmus Edge instance. See [Step 2: Create an Activation Configuration in Litmus Edge Manager](docId\:vVZ99_j_TGxX6b9-Y9f8L) to learn more. - View and change the license status of one specific Litmus Edge instance. See [License](docId\:yNEZ4ZGTuD6lrZxdTMcz5). - Manage site licenses that Litmus Edge instances will receive (and the Litmus Edge Manager itself can also receive). See [License Server Management](docId:5U_hNNsaVs--E5HQJEQ0O). # Litmus Edge Manager Site Licenses and Node-Locked Licenses Compared | **Site License** | **Node-Locked** | | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- | | Access to features/capabilities depends on type of license.
Activation can be completed offline. | Provides access to all Litmus Edge Manager features.
Activation can be completed online or offline. | | Can be upgraded with additional features/capabilities. | Can be upgraded with additional features/capabilities. | [title] Change the IP Address of Litmus Edge Manager [path] How-To Guides/Litmus Edge Manager Admin Console Guides/ You can change the IP address used to access Litmus Edge Manager to a new IP address. If you have installed Litmus Edge Manager on ESXi and there is no IP address shown to access the interface, you must set a static IP address. See [Set a Static IP Address](docId\:eu1MB0qeHF67YNC6i3ohh) to learn more. # Video :::Iframe{code=""} ::: # Step 1: Add a New IP Address to Interface You will first need to add the new IP address to the *Interfaces *section of the *Network *page. **To add a new IP address:** 1. Navigate to Litmus Edge Manager Admin Console's **Settings > Network > Interface **tab, and click **Update**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Lc0RblsHHm_r8nwOWlVOM_2023-07-2409-07-52.png "Adding a new IP address") 2. Click **Add new Address.** 3. Enter the following fields - For the *IPv4 Address* field, enter the **new IP address in CIDR notation **that will be used to access Litmus Edge Manager. - For the *Gateway* field, enter the IPv4 Address's respective **Gateway** value. - For this example, `172.20.21.114/23` and `172.20.20.1` will be used. 4. Click **Update. ** ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/u6BiHzuloCV46cMouduld_image.png" size="80" width="1920" height="866" caption="Adding a New IP Address to Interface" position="center" showCaption="true"} :::hint{type="warning"} **Important**: Wait 15 minutes for the changes to be implemented before moving to the next step. ::: # Step 2: Change Base Domain Name to the New IP Address After waiting for the new IP address to be implemented, you can update the base domain name. :::hint{type="info"} **Note**: The base domain name will be automatically updated to the new IP address if the following is true: - The DHCP checkbox for the interface was not selected. - The previous base domain name was an IP address rather than a domain name. - The previous base domain name was not included as an IP address for the interface. ::: **To change the base domain name: ** 1. Navigate to Litmus Edge Manager Admin Console's **Settings **> **Domain/SSL** pane. 2. For the *Base Domain Name* field, enter the** IPv4 address **from the previous step. You will need to reactivate any Litmus Edge devices previously activated by this Litmus Edge Manager. 3. Click **Save**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0hC6UVX_SCZ5rvkBq0B1D_image.png" size="80" width="1920" height="866" caption="Change Base Domain Name" position="center" showCaption="true"} # Step 3: Change Edge Remote Name to the New IP Address You will need to wait for the new base domain name to be implemented before update the Edge remote name. **To change the Edge remote name: ** 1. Wait several minutes for the changes to be implemented. Then, open a new browser and access the Litmus Edge Manager Admin Console using the new IPv4 address (in this use case, it would be: `172.20.21.144:8446`) from Step 1 and Step 2. 2. Navigate to **Settings **> **Domain/SSL**. 3. For the *Edge Remote endpoint* field, enter the** IPv4 address **from *Step 1: Add a New IP Address to Interface*. The *Base Domain Name* field and *Edge Remote endpoint* field should be identical. 4. Click **Save**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/7Aqe2Ky7tikkegs1A7LQ__image.png" size="80" width="1920" height="866" caption="Change Edge Remote endpoint" position="center" showCaption="true"} # Step 4: Remove Old Address from Interface and Disable DHCP The final step is to remove the old IP address from the interface and disable DHCP. **To disable DHCP and remove an old IP address:** 1. Navigate to **Settings > Network > Interface **tab and click **Update**. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/0qb8XH098J19I53ItfL3L_2023-07-2409-12-46.png "Updating interface") 2. Disable **DHCP** by unselecting the checkbox then click **Update**. This will set the interface from *DHCP* to *Static*. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/TXj0wQxNSIaLvWZg3xTBH_disable-dhcp.png" size="80" width="1920" height="866" caption="Disable DHCP" position="center" showCaption="true"} 3. Click **Update** again. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/Zwc_LU3FWl_FgWWLYMr35_network-static.png" size="80" width="1558" height="499" caption="Static interface" position="center" showCaption="true"} 4. Delete the old IPv4 address and then click **Update**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/jldnHUq5-o1XgWPJYlp1e_image.png" size="80" width="1920" height="866" caption="Delete old IPv4 Address" position="center" showCaption="true"} [title] Litmus Edge Manager 2.11.0 [path] Product Updates/2023/ Release Date: June 13, 2023 ## New Features The following are new features introduced in this software release: | **Description** | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Activation:**
* Activation Configuration now offers a new *Advanced Settings* section. This section provides you the opportunity to customize the Remote Access (the connection between Litmus Edge Manager and Litmus Edge) parameter `PersistentKeepalive`(the interval in seconds of how often to send an authenticated empty packet to a Litmus Edge). | | **Edge Devices:**
* Added a new *Settings* tab at **Admin Console** > **Edge Devices** > **Edge Remote Networks** to enable you to configure the Maximum Transmission Unit (MTU) of the Remote network interface. | | **Marketplace**
* Marketplace now offers the creation and synchronization of Primary and Secondary catalogs. A new *Synchronization* section has been added in each marketplace catalog application. This section enables you to synchronize a Secondary catalog to become identical to a Primary catalog. | ## Enhancements and Features The following features and enhancements are included in this software release: | **Description** | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Keycloak:**
* Upgraded keycloak to 20.0.3. | | **Personal Settings:**
* The *Litmus Customer Success *(Open support chat) widget is now collapsible to prevent other UI elements from being blocked and/or unclickable. | | **Templates:**
* The *Description* field now has a character limit of 512. * Templates list now provide statistics for each template. * Redesigned *Create Template from device* to be similar to Litmus Edge's user interface version. | | **Alerts:**
* When setting up a Metrics-based Trigger, *Alert Delay, seconds *must be at least 60 seconds. * When setting up a Metrics-based Trigger, *Target Value* is now in *msgs/minute* rather than msgs/seconds. | | **License:**
* You can now both add add-on Litmus Edge Manager Node-locked licenses and upgrade core Litmus Edge Manager Node-locked licenses at **Admin Console** > **Settings **> **License**. | ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Templates:**
* Fixed an issue when uploading an invalid Parameterized Template (*.zip* folder). It previously yielded a successful result message but didn't add the template. It will now accurately display an error message. | | **Company List:**
* Fixed an issue with companies duplicating after changing company name. | | **Alerts:**
* Fixed an issue with Metrics alerts for Connector online status operating improperly. | | **Data Lifecycle:**
* Fixed an issue with graph and information not being displayed correctly for **Admin Console** > **Data Lifecycle** > **Statistics**. * Fixed an issue with searching by project name failing to yield search results for **Admin Console** > **Data Lifecycle** > **Management**. | | **Security:**
* Resolved a vulnerability related to CVE-2023-28322. | ## Known Issues The following issues are unresolved in this release: | **Description** | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Installation:**
* Azure-Marketplace-installed Litmus Edge Manager will redirect to internal IP address. **Workaround**: From Admin Console > Settings > Domain/SSL, set the values of *Base Domain Name* and *Edge Remote endpoint *as external IP address. | | **Edge Devices:**
* Expired site-based licenses do not display their expired status. | | **Templates:**
* When creating a template, NTP, DNS, Timezone, Country, and Docker Data are automatically incorporated. * Uploading a template file circumvents the 512 character limit for *Template Description*. * Two or more templates can share the same description. | | **Upgrade:**
* Users are able to downgrade Litmus Edge Manager to an earlier version. | [title] Litmus Edge Manager 2.15.0 [path] Product Updates/2023/ Release Date: December 20, 2023 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## New Features | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Admin Console Settings**:
* A new **Management **page allows you to reboot Litmus Edge Manager. * A new **Backup **page allows you to download and upload backup files of Litmus Edge Manager. | ## Enhancements and Features | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Remote Networks**:
* You can now view the number of devices that can be activated for the project. - You can view the following information for the remote network and the entire instance: - The maximum number of nodes - The number of free slots - The capacity of activated devices remaining represented as a percentage value | | **Support:**
* When downloading a support bundle, you now have the option to download config and log details, or only download log details. | | **Software Jobs:**
* You now have the option to schedule software update jobs to run at a specified time. | | **Edge Devices**:
* When viewing edge device details and navigating to the **Manage **tab, a new **Software **sub-tab allows you to do the following: - View the list of downloaded updates. - Delete existing update files. - Run updates for selected update files. * There is now a limit of 100 child devices that can be created for each Edge device. * You now have the option of backing up multiple edge devices. | | **Tokens**:
* A new option for **Edge API Bridge** when creating a token allows you integrate multiple Litmus Edge REST APIs through a single Litmus Edge Manager endpoint. This is especially useful when incorporating Litmus Edge Manager into your CI/CD workflows, streamlining the integration process. | | **Backup/Restore**:
* The backup and restore functionality has been improved to enhance reliability. This change has caused data (Clickhouse) backup to be excluded. | ## Resolved Issues | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------ | | **Integration**:
* Fixed issue with device data not being stored in Clickhouse. | | **Security:**
* Resolved the following vulnerabilities: - CVE-2023-44981 - CVE-2023-38545 | | **Alerts**:
* Fixed issue with alert delay values under 60 seconds not displaying correctly. | | **Edge Devices**:
* Fixed issue with edge devices not displaying data for *MQTT Last Known IP* and *MQTT Last Seen Date*. | ## Deprecated Components and Features | **Description** | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Admin Console Settings**:
* The options for **Export Configuration **and **Import Configuration** in the *Export/Import Data* page are no longer available. These options have moved to the new *Backup *page. | [title] Litmus Edge Manager 2.16.4 [path] Product Updates/2024/ :::hint{type="warning"} **Important**: For a seamless upgrade experience in upcoming releases, it's crucial to upgrade to version 2.16.4 before making any further upgrades. Skipping the initial upgrade to version 2.16.4 may disrupt the upgrade process, and is therefore not recommended. ::: Release Date: March 28, 2024 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Enhancements and Features | **Description** | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Devices**:
* The Nginx limit for the activation endpoint of 10 rps (requests per second) is now removed, allowing for more Edge devices to be processed at one time. | | **Admin Console Settings**:
* You can now set a static IP and gateway DHCP setting. | ## Resolved Issues | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Devices**:
* Fixed issue with incidents being created for previously deleted devices. | | **Admin Console Settings:**
* ****Fixed issue with the Marketplace Catalog not being available after upgrading from version 2.15.0 to 2.16.0. | | **Software Update Tasks**:
* Fixed issue with a failed status displaying when upgrading Edge device software (Litmus Edge) to 3.11.0 even though the upgrade was successful. This occurred if the upgrade lasted more than five minutes. | | **Interfaces**:
* Fixed issue with errors being generated when to trying to add a new network interface. | | **Integration**:
* Fixed issue with data (OMA and RAW) from multiple projects not being successfully loaded into tables (dev\_parent\_pretty\_name columns) in Tabix. | | **Software Updates: **
* Fixed issue with upgrades through update files failing because of insufficient disk space. **** | | **User Interface**:
* Fixed issue with the user interface loading before Keycloak is ready to run. * Fixed issue with being directed to the project list page after refreshing the browser window. | | **Domain/SSL**:
* Fixed issue with an error message displaying when changing the domain name despite a successful change of domain name. | | **Support**:
* Fixed issue with MySQL files not being included in support bundles when you select *Include configs*. | | **Network**:
* ****Fixed issue with the incorrect Netplan config of 0.0.0.0 as the default router. The correct default router is now 0.0.0.0/0 or default. | | **Security:**
* Resolved vulnerabilities related to CVE-2023-6267. | | **License**:
* Fixed issue with the Kubernetes version of Litmus Edge Manager not being able to successfully check the license type. | ## Deprecated Components and Features | **Description** | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Devices**:
* The following deprecated services are no longer available from the **Manage edge device(s) services** option: - DeviceHub Service - BACnet Server - Flows - Remote Access | [title] Litmus Edge Manager 2.12.0 [path] Product Updates/2023/ Release Date: July 18, 2023 ## New Features | **Description** | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **License Server Management:**
* A new *License Clients* tab allows you to create activation requests for devices to connect to a custom license server through a proxy. | ## Enhancements and Features | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Support:**
* Clickhouse logs and upgrade logs are now available in support bundles. | | **Activation:**
* If there is an unsuccessful activation through the license server, more details are now included in the error message to assist in troubleshooting. * You now have the option of automatically applying the default password policy in Litmus Edge Manager to activated devices. | | **Settings:**
* You have the option storing edge device data (OMA and RAW) in Clickhouse. * You can configure the backup retention policy for edge device data by setting the number of backups to store. | ## Resolved Issues | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Devices:**
* Fixed issue where expired site-based licenses do not display their expired status. | | **System:**
* Addressed vulnerabilities related to the following: - CVE-2022-0265 - CVE-2023-34034 - CVE-2022-1471 - CVE-2016-1000027 - CVE-2022-45047 | | **Marketplace:**
* Fixed issue with an older Docker version causing the Marketplace Catalog app to crash. | | **Templates:**
* Fixed issue with NTP, DNS, Timezone, Country, and Docker Data being automatically added to templates. | | **Upgrade:**
* Fixed issue with being able to downgrade Litmus Edge Manager to an earlier version. * Fixed issue with not being able to upgrade Litmus Edge through Litmus Edge Manager. | | **Installation:**
* Fixed issue with the domain name not being provisioned for Litmus Edge Manager when deployed from the Azure Marketplace. | | **Users:**
* Fixed issue with an incorrect success message displaying after an unsuccessful attempt to add a user. | ## Known Issues | **Description** | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Marketplace:**
* Marketplace applications may not launch successfully if you do the following: - In Litmus Edge Manager version 2.2.2, add a new catalog and import an application. - Upgrade Litmus Edge Manager from 2.2.2 to 2.12.0. - Activate a Litmus Edge version 3.5.5. - Launch the imported application in the activated Litmus Edge 3.5.5. | | **Templates:**
* Uploading a template file circumvents the 512 character limit for *Template Description*. * Two or more templates can share the same description. | | **Digital Twins:**
* If a hierarchy is unsuccessfully saved, the error message provides no details on the cause of the error. | | **Edge Devices:**
* The disk usage data for edge devices may not display correctly and hide the value. * The Docker version of Litmus Edge Manager may not display events after enabling the **Forward Events** feature. | [title] Litmus Edge Manager 2.31.2 [path] Product Updates/2026/ Release Date: April 15, 2026 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Resolved Issues | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Digital Twins:**
* Fixed issue where all fields were considered mandatory even though only Model Name and Attribute Name are required when importing dynamic attributes through a CSV file. | | **Applications:**
* Fixed issue where values for private variables were visible in App Parameters for Marketplace applications. | | **Edge Devices:**
* Fixed issue where an SSL certificate error occurred and a `permission denied` message displayed when attempting to activate an edge device. | | **Alerts:**
* Fixed issue where some incident alerts were incorrectly marked as resolved in Litmus Edge Manager when Litmus Edge lost connectivity. | | **System**:
* Fixed issue with Git Integration where temporary directories were not cleaned up which caused high disk usage. * Fixed issue where Azure Entra ID SSO failed with a `Restart login cookie not found. It may have expired; it may have been deleted or cookies are disabled in your browser` error. This occurred after upgrading LEM from version 2.26.1 to 2.31.1. * Fixed issue where upgrading Litmus Edge Manager directly from version 2.16.7 to 2.31.1 could fail with a `Failed to stop lem-admin-healthcheck.timer: Unit lem-admin-healthcheck.timer not loaded` error. * Addressed vulnerabilities in third party components. | [title] Increase Disk Size Of Azure Virtual Machine [path] How-To Guides/Litmus Edge Manager Admin Console Guides/ You can add data disks to your existing Azure Virtual Machine (VM) if you encounter issues due to insufficient disk space or legacy applications. :::hint{type="warning"} **Caution:** Remember that you can only resize a disk to a larger size. ::: # Before You Begin: - Obtain an Azure account. See the [Microsoft Azure portal](https://azure.microsoft.com/en-us/features/azure-portal/). - Access to Azure portal and a VM running on Azure. # Step 1: Increase the Disk Size As you deploy more applications, increase the load of your databases, or require more resources, you can add data disks to the existing VM to increase its disk size. **To increase the size of your virtual machine data disk:** :::hint{type="info"} **Important: **Changing the size of the disk can also change the level of the disk tier and may have extra costs. For more information, see [Performance tiers for managed disks](https://learn.microsoft.com/en-us/azure/virtual-machines/disks-change-performance). ::: 1. Open the *Microsoft Azure* home page, and then navigate to **Virtual Machines**. 2. Select the **VM** you want to resize and in the toolbar, click **Stop**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/IplOLvKahqSbab7a7XZAl_image.png" size="70" width="1121" height="463" position="center" caption="Virtual Machines pane" showCaption="true"} 3. After stopping the machine, navigate to the **Settings** section and click on **Disks**. 4. From the list of attached disks to your VM, select the one you want to resize. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/kJQsEe7mqbFGx3SPjdVx6_image.png "Disks page") 5. From the *Disk Overview* page, scroll to **Essentials** pane. You can see the default size of your disk in *Disk Configuration*. 6. To increase its storage capacity, navigate to **Size + performance** under the *Settings *section. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/3NZhgCFiulSceuGXSNyO8_image.png "Disk Overview page") 7. On the resulting screen, modify the value of the **Custom disk size (GiB) **section and click the **Resize **button to finish the process. In this example, the size was increased from 30 to 64 GB and the performance tier has also changed accordingly from P4 to P6 as shown below. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/64SCU1RLNqdMgJmiP2NdL_image.png "Size + performance page") 8. Navigate back to *Virtual Machine *home page to start the VM. 9. Click the **Start **button and wait until the *Status *section changes from `Stopped (deallocated)` to `Running`. # Step 2: Verify the Disk Size The next step is to verify that both the partition and filesystem have been successfully resized to ensure that the disk can now be used with the new storage space size. To do this, [connect to the VM through SSH](https://docs.bitnami.com/azure/faq/get-started/connect-ssh/) and execute the following command: ```shell $ df -dh ``` The output shows that the disk space was correctly resized. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/963unYctMoUZ26XXHF30g_image.png "Output window") [title] Set a Static IP Address [path] How-To Guides/Litmus Edge Manager Admin Console Guides/ You can set a static IP address for Litmus Edge Manager instead of using DHCP. If you have installed Litmus Edge Manager on ESXi and there is no IP address shown to access the interface, you must set a static IP address. If you would like to change the current IP address used to access Litmus Edge Manager, see [Change the IP Address of Litmus Edge Manager](docId\:qcv7MR9ma_fzEqjKizQpC). Depending on your version of Litmus Edge Manager, refer to the appropriate steps. # Litmus Edge Manager Version 2.16.0 and Later These steps are for Litmus Edge Manager 2.16.0 and later on Ubuntu 22. Network configuration is managed by Netplan [https://netplan.io/](https://netplan.io/). **To set a static IP address: ** 1. Login to the VM console. 2. Use the following command to get the filename in the NetPlan config directory. Depending on the Linux distribution NetPlan configuration, the file can have different filenames. `sudo ls -l /etc/netplan` The default configuration looks like the following: ```yaml network: ethernets: ens192: dhcp4: true version: 2 ``` You will need to update this configuration. As an example, you will disable DHCP and set the static IP address of 10.17.8.146/22 with the default router of 10.17.8.1. The configuration will be updated to the following: ```yaml network: ethernets: ens192: dhcp4: false addresses: - 10.17.8.146/22 routes: - to: default via: 10.17.8.1 version: 2 ``` Apply the configuration with the following command. :::BlockQuote sudo netplan apply ::: Once the new IP address is set, if the base domain name was set as an IP address, log in to the Litmus Edge Manager Admin Console (https\://\[LEM IP address]:8446) and update the base and remote domain names. See [Domain Settings](docId\:MC8Z1bK3yWcKQq4-kupCv) to learn more. If you get an error message that the network interface configuration failed, see [Static IP Address Error](docId\:qcfAzyS-rv5d-3oeSlLf3) to resolve it. # Litmus Edge Manager Version 2.15.0 and Earlier These steps are for Litmus Edge Manager 2.15.0 and earlier on Ubuntu 18. **To set a static IP address: ** 1\. From a command prompt, enter the following: :::BlockQuote NEW\_IP=xxx.xxx.1.222 sudo /opt/lem/bin/lem-update-domain-names.sh $NEW\_IP $NEW\_IP sudo /opt/lem/bin/stop-all-nomad-jobs.sh sudo vi /etc/netplan/01-netcfg.yaml ::: The `.yaml` file opens. :::hint{type="info"} **Note**: The `.yaml` file is located in `/etc/netplan/01-netcfg.yaml`. ::: 2\. Enter the following lines in the `.yaml `file while substituting `x` with the relevant numbers: ```yaml network: version: x ethernets: eth0: dhcp4: false addresses: [xxx.xxx.x.xxx/xx] gateway4: xxx.xxx.x.x nameservers: addresses: [x.x.x.x,x.x.x.x] ``` 3\. From a command prompt, enter the following: :::BlockQuote sudo netplan apply sudo reboot ::: [title] Litmus Edge Manager 2.10.1 [path] Product Updates/2023/ Release Date: May 05, 2023 ## New Features The following are new features introduced in this software release: | **Description** | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Marketplace:**
* When an application release containing the special variable named `EDGE_API_TOKEN` is deployed to a Litmus Edge instance, the Litmus Edge will generate a token (REST API Key) named `MPC-APP` and pass it to the application release's respective Docker container. | | **Integration:**
* *Prometheus* and a Prometheus *Alert Manager *is now supported. | | **Network:**
* Added a new *DNS* tab, enabling you to configure the DNS servers that Litmus Edge Manager connects to. | ## Enhancements and Features The following features and enhancements are included in this software release: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | - Litmus Edge Manager instances are now more compatible with Load Balancers. Previously certain Litmus Edge requests would be dropped. | | **Dashboard:**
- *VM Time* has been reworded to *System Time*. - A warning in Admin Console > Dashboard will be shown if *System Time* in and your Local time differs by 10 minutes. - Large numbers in Admin Console > Dashboard have been altered to be easier to read. | | **Licenses:**
- Whitespace is no longer allowed while entering a license key. - When* Site* license is chosen in Admin Console > Settings > Licenses, *Available Licenses* will no longer be displayed. | | **Edge Devices:**
- Redesigned the user interface for child DeviceHub devices. - When *Forward Events* is enabled, and the connection with a Litmus Edge is lost, a more detailed error message is now displayed. - Parameterized templates can now be successfully downloaded from Admin Console > Edge Devices > Edge Device Templates. - When searching for a password policy (in Admin Console > Edge Devices > Edge Password Policies) with a keyword, only matching policy names will be displayed. Previously, both matching policy names and matching policy descriptions were displayed. - When adding a new Edge Remote network (in Admin Console > Edge Devices > Edge Remote Networks), all IPv4 addresses that are in the format `0.xxx.xxx.xxx/8` are no longer allowed. | | **Applications:**
- When you include the `EDGE_API_TOKEN` parameter in an application release deployment, the parameter will be read only. | | **Software**:
- Applying software updates for Litmus Edge 3.5.0+ is now more reliable. | | **Company Settings:**
- When adding a new user, a warning will be displayed when SMTP is not set. | | **Data Lifecycle:**
- In cases where there are multiple versions of the same archived file, version numbers have been added to the file name. - Temporary files are now created in the `/var/lib/lem/tmp` directory. - Free diskspace space limit can now only be set between 0%-50%. | | **Network:**
- When DHCP is disabled, the interface will now require at least one IP address with a gateway. | | **Support:**
- Concurrent support bundle downloads are no longer allowed. - When support bundle generation fails, an error message will now be displayed. - Support bundles now also contain a configuration DB dump. | | * Network configuration MTU is now configurable. | ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Login:**
* Fixed an issue where incorrect *System Time* prevented logins. | | **Dashboard:**
* Fixed an issue with *Dashboard* *tagcount *being inconsistent with the tag count in [Edge Devices](docId\:pqRVYqspADLvoCpHmC3WA). * Fixed an issue where the pagination block in Admin Console > Dashboard was displaying even though there are no statistics to display. | | **Edge Devices:**
* Fixed an issue where edge device details were not displaying while license info was still loading. * When Metrics are not available, DeviceHub devices will now display `Metrics are not available` rather than incorrectly displaying them as offline. | | **Activation:**
* Fixed an issue with activation fails when the User Root CA certificate is not uploaded. | | **Templates:**
* Fixed an issue where parameterized templates cease being parameterized when the scope is edited | | **Alerts:**
* Fixed an issue with emails not being successfully sent. | | **Marketplace:**
* Fixed an issue where `enum`-type variables weren't displaying during application deployment. * Fixed an issue where the Litmus Edge Manager Site license with catalog feature did not enable the *Marketplace* feature and the *Application* page. | | **Data Lifecycle:**
* Fixed an issue where archived files may be overwritten. * Fixed an issue where Purge Policies weren't executing properly. * Fixed an issue where events data is not automatically purged after archiving. | | **Integration:**
* Fixed an issue with broken *Tabix* UI when accessing the UI from Litmus Edge Manager. | | **Network:**
* Under *NTP Client Settings*, when adding an incorrect NTP server, the error message now contains a description of the error. | | **Email:**
* Fixed an issue with *Email Settings* not being available for the Kubernetes version. | | **Licenses:**
* Fixed an issue where trial license in Admin Console > Settings > Licenses displayed incorrectly expired features. | | **Support:**
* Fixed an issue where support bundles couldn't be downloaded. | | **Security:**
* Resolved a vulnerability related to CVE-2022-23806. | ## Deprecated Components and Features The following components/features will no longer be available: | **Description** | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Company List:**
* When creating a new company, domain resolving validation has been removed. | | **Edge Devices:**
* The *Remote* tab has been removed. | | **Remote Access:**
* The *ZeroTier* tab has been removed. | | **Alerts:**
* Most *System Triggers* have been removed except for alert failure system trigger. * When adding/editing triggers, *Data* sources have been removed. They have been replaced with *Metrics*. | | **Network:**
* The *Remote network* tab (containing ZeroTier Network customization) in Admin Console > Settings has been removed. | ## Known Issues The following issues are unresolved in this release: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Templates:**
* When uploading an invalid Parameterized Template (*.zip* folder), it will yield a successful result message but won't add the template. | | **Alerts:**
* Metrics alerts for Connector online status may not operate properly. | [title] Connect Litmus Edge Instance to License Server [path] How-To Guides/Litmus Edge Manager Admin Console Guides/ You can connect a Litmus Edge instance directly to a License Server within the Litmus Edge Manager (LEM) Admin Console. This method allows you to configure the license server on the Edge device itself, bypassing the usual activation process initiated from the LEM user interface. Before You Begin - Ensure you have an unactivated instance of Litmus Edge. - Familiarity with [Licenses](docId\:vbAuxHNHFHDN2MK8-8zgQ) and [License Server Management](docId:5U_hNNsaVs--E5HQJEQ0O). # Step 1: Generate and Copy the Configuration Key in Litmus Edge Manager 1. Log in to the **Litmus Edge Manager (LEM) Admin Console**. 2. From the navigation panel, select **License Server Management**. 3. In the *License Server Management* pane, access the **License Clients **tab. 4. Click the **Add **icon to create a new request for a device. The *Create New Request *dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/plDOBj9uJ0tO3buyzNAeZ_image.png" size="70" width="1280" height="648" position="center" showCaption="false"} 5. Configure the request by entering the following: - **Label:** Unique name to identify the device. - **URL:** Review the URL for the license server. - Click **Create**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/eNB4wSI2cJtK-4bLxbwm4_image.png" size="70" width="1205" height="615" position="center" showCaption="false"} 6. The *New Request Created *dialog box displays the activation request/configuration key. 7. Click the **Copy **icon for the activation request to copy it to your clipboard. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/wMRQVOCDsA0b_qJzjd0M9_image.png" size="50" width="497" height="314" position="center" showCaption="false"} # Step 2: Access License Settings in Litmus Edge 1. In a new browser window, log in to the **Litmus Edge **instance you want to activate. 2. From the navigation panel, navigate to **System **> **Activation **> **License**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/hVaSsZQkR702mzmC8BEvB_image.png" size="70" width="1280" height="815" position="center" showCaption="false"} # Step 3: Set the License Server Configuration 1. From the *License Server Settings* section, click **Set Server**. The *Set License Server Configuration* dialog box appears. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/ehdIfuQHXE5q46cx0gJmJ_image.png" size="70" width="1230" height="536" position="center" showCaption="false"} 2. In the *Configuration *field, paste the key you copied earlier. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/1Qxws4oWQlM8Pe9sWatMy_image.png" size="70" width="1280" height="727" position="center" showCaption="false"} 3. Click **Save**. If the activation is successful, a success message is displayed. Once the license server is set, you will have access to the site license. :::hint{type="success"} **Tip: **You must refresh the page if you don't see the *UP* status. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/4MrSFFsDoQ4N4TZ81oTYE_image.png" size="70" width="1280" height="484" position="center" showCaption="false"} ::: # Step 4: Verify the Connection in Litmus Edge Manager 1. Navigate back to **LEM Admin Console** > **License Server** **Management** > **License Clients.** 2. Under the list of edge devices authorized on the license server, you can find the *Label*, *Host ID*, *Host Name*, *Company/Project*, *Last Seen*, *Request Type*, and action for revoking activation. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/sUUQMldRc9fSwwSl_CTXB_image.png) [title] Litmus Edge Manager 2.3.3 [path] Product Updates/2022/ Release Date: March 25, 2022 ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ---------------------------------------------------------------------------------------- | | Fixed issue with inability to access the Users tab in Litmus Edge Manager Admin Console. | ## Known Issues The following issues are unresolved in this release: | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------- | | For FireFox browser with self-signed certificate, there are failures on all file uploads of Litmus Edge on Litmus Edge Manager Admin Console. | | Parametrized templates are not supported for instance-level templates | | The Admin Dashboard usage stats are inconsistent with the Data Lifecycle Management statistics | [title] Litmus Edge Manager 2.16.0 [path] Product Updates/2024/ Release Date: January 4, 2024 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Enhancements and Features | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Domain/SSL**:
* If there are issues when trying to change SSL settings, the error message now provides details on the cause of the issue. * You can no longer upload SSL or CA certificates with private keys. * You can now view more info for SSL certificates. | | **Edge Remote Networks:**
* The range of the MTU setting is now between 576 bytes and 1500 bytes. Previously, the range was between 1280 bytes to 1500 bytes. | | **Admin Console**:
* Validation of remote domain name is no longer required. | | **Admin Console Settings**:
* In **Upgrade**, the *New Versions* section is now renamed *Software Update Files* for better clarity. | ## Resolved Issues | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Devices**:
* Fixed issue with device descriptions updated in Litmus Edge not updating in Litmus Edge Manager. | | **Admin Console: **
* ****Fixed issue with the Admin Console user interface freezing if you try to upload a user certificate with a passphrase-protected private key. * Fixed issue with updated MTU values in **Edge Remote Networks** not saving. | | **Backup**:
* Fixed issue with errors being generated for Grafana authentication after restoring an LEM backup. | | **Integration**:
* Fixed issue with insufficient space errors when trying to archive data for Clickhouse. | | **User UI Settings**:
* Fixed issue with not being able to successfully create a topic in **User UI Settings** > **Credentials **> **Topics **with the name "+". | | **Integration**:
* Fixed issue with Tabix not being able to successfully use an API call to load the Monaco editor. | [title] Litmus Edge Manager 2.7.0 [path] Product Updates/2022/ Release Date: December 30, 2022 ## New Features The following are new features introduced in this software release: | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | A new Task List (Task Details, SubTask log) has been introduced to monitor resource-heavy tasks applicable to multiple Litmus Edge instances. | | When accessing the version number, a new option in **Personal Settings **is available. The **Connected Feature** enables the customer chat box. | | **Integration:**
* Log forwarding to an external Syslog server is now supported. | | **Admin Console Settings:**
* Litmus Edge Manager now offers long-term API Tokens. | ## Enhancements and Features | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Login:**
* A loading indicator now displays when logging in to Litmus Edge Manager. | | **Overall:**
* Improved performed for operations (such as deploying) that apply to multiple Litmus Edge instances. * The Admin Console menu has been redesigned. | | **Dashboard:**
* System (Device and Up) time is now displayed. | | **Dashboard:**
* Redesigned Dashboard layout. * Every alert will now contain details about the originating source. | | **Edge Devices:**
* Edge Device time is now displayed. | | **Edge Devices:**
* Litmus Edge licenses are now removable. * Online licenses can now be upgraded. | | **Activation:**
* When activating Docker type edge devices, a failed activation error message now contains additional details. | | **Software:**
* Edge Device names with MAC addresses are now displayed instead of Edge Device ID. | | **Marketplace:**
* LEM users with a Grafana Administrator role will now also receive an Admin Role in the Grafana organization. | | **Admin Console Settings:**
* Offline activation for LEM licenses are now supported. | | **Asset Management Model:**
* Changed the model modification user interface with new customizations (Static Attributes/Transformation/Dynamic Attributes/Hierarchy) | | **Integration:**
* Updated Tabix to the latest version of 22.15.7. | ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Keycloak:**
* Fixed an issue with Keycloak redirected URLs. | | **Sites:**
* Fixed an issue where uploading new site images doesn’t replace the old image, thereby wasting diskspace. | | **Applications:**
* Fixed an issue where it is possible to deploy an application even before the Litmus Edge has the capability to receive the application. | | **Edge Devices Details:**
* When adding a license key, online/offline license activation is now re-enabled. * Fixed an issue with unsuccessful attempts to add datapoint licenses. | | **Features:**
* Fixed an issue related with the Prometheus URL in Grafana settings. | | **Admin Console:**
* Fixed an issue with the Admin Console not fully working without running Hazelcast. * Fixed an issue where a site-licensed, installed Litmus Edge Manager was displaying number of days before the license expires. | | **Asset Management:**
* Fixed an issue where a Litmus Edge-created instance did not show up on Litmus Edge Manager. | | **Admin Console Settings:**
* Fixed an issue where disabling EdgeEvents did not disable the User UI: Edge Devices > Edge Device Details > Events Tab. | | **Security:**
* Cipher suites have been updated to address SSL LUCKY13 vulnerability. | ## Deprecated Components and Features The following components/features will no longer be available: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Settings:**
* The OMA Registry tab has been removed. | | **Admin Console Settings:**
* Remote UI, Parametrized template, EdgeRemoteNetwork are now no longer experimental features. They are now fully part of Litmus Edge Manager User UI features. | | **Admin Console Settings:**
* For the current version, the version size has been removed. | [title] Litmus Edge Manager 2.5.1 [path] Product Updates/2022/ Release Date: October 14, 2022 ## New Features The following are new features introduced in this software release: | **Description** | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Admin Console Settings:**
* Google Cloud Platform Cloud Credentials can be stored in `.json` format. * Storage settings can be set to either *Local* or *Google Cloud Storage*. | ## Enhancements and Features The following features and enhancements are included in this software release: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Overall:**
* Restructured *Settings* menu. * Removed various critical security vulnerabilities throughout Litmus Edge Manager. | | **Company List:**
* Companies are now split between *Edge Lifecycle Management* and *Asset Management*. - *Edge Lifecycle Management*: Where users can manage Litmus Edge devices. - *Asset Management*: Where users can access the Digital Twins module. | | **Applications:**
* Catalogs can now also be pushed to Litmus Edge devices.
**Applications:**
* Logs are now provided for multi-container application. | | **Alerts:**
* Tag values can now be used as a Source of a trigger and/or as part of the return message. | | **Admin Console Settings:**
* Support Bundle now contains all user actions. | ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Installation and Configuration:**
* Litmus Edge Manager will now successfully launch on Virtual Machines. Previously failed with error: `/usr/bin/vaultbot: No such file or directory` | | **Edge Devices:**
* When accessing a Litmus Edge using RemoteUI, its *Flow Manager*>*Flow Definition*>*dashboard* external link was previously not reachable. (Still reachable when accessing the Litmus Edge directly, without using the Litmus Edge Manager RemoteUI.) This has been fixed.

**Edge Devices:**
* Litmus Edge Manager can now successfully create a backup of an activated, licensed-provisioned Litmus Edge instance. Previously failed to create backup with `message: "HTTP error: status=500 INTERNAL_SERVER_ERROR; response=couldn't upload backup: unexpected response"`. * Resolved an issue when creating a backup of Litmus Edge instance with perpetual (node-locked) license. | | **Activation:**
* Creating/modifying an activation configuration with a *Lease TTL* value beyond CA certificate expiration date is now restricted. | | **Applications:**
* For an application that has been deployed to multiple Litmus Edge devices, all the Litmus Edge devices will now be displayed. Previously only displayed one Litmus Edge device. * Marketplace Catalogs in *Draft* state will no longer be available for deployment to Litmus Edge devices. * Reworded *Upgrade Application* to *Update Application*. | | **Users:**
* Deleting a user with Grafana Administrator role will now automatically delete that same user from Grafana. | | ** Docker:**
* Uploading a docker image now shows correct creation date. | ## Deprecated Components and Features The following components/features will no longer be available: | **Description** | | ----------------------------------------------------------------- | | **Admin Console:**
* Separate port 8445 is no longer needed. | [title] Troubleshooting [path] / [title] Acronym List [path] Resources/ While many acronyms have become part of our common language, with their meanings well known to people in the industry, it can be entertaining to review the origin or decoded version of an acronym. The following list includes common acronyms found in the product documentation. | **Acronym** | **Decoded** | **Description** | | ---------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **ACL** | Access Control List | Lists the users and permissions for system access. | | **AES** | Advanced Encryption Standard | This security algorithm encrypts and decrypts data using the same encryption key. Software uses this standard to enforce privacy controls on each device and connection. | | **AMQP** | Advanced Message Queuing Protocol | Open standard for business application messaging. | | **BPM** | Business Process Management | This business solution focuses on optimization of business processes and workflows. | | **CDN** | Content Delivery Network | Network nodes and content are located closer to the end user than with typical network configurations. | | **CIDR** | Classless Inter-Domain Routing | The standard for creating unique identifiers for networks and individual devices. | | **CNC** | Computer Numerical Control | This pre-programmed sequences of commands enables automation of machine tools. | | **CoAP** | Constrained Application Protocol | Web-transfer protocol for IoT constrained nodes and networks; designed for machine-to-machine (M2M) applications. | | **CRM** | Customer Relationship Management | This software manages a database of interactions with customers and potential customers. | | **CSR** | Certificate Signing Request | Send this encoded file to a certificate authority for creation of an SSL certificate. | | **DCS** | Distributed Control System | A computerized control system for a process in which autonomous controllers are present in the system without a central operator supervisory control. | | **DTC** | Diagnostic Trouble Code | Engine control systems in vehicles issue DTCs for problems and failures. For example, a DTC triggers the check engine light in an automobile. | | **DTLS** | Datagram Transport Layer Security | Protocol for secure communications for datagram-based applications (UDP transport protocol). | | **ERP** | Enterprise Resource Planning | This software integrates and manages core business functions/units in a shared database. | | **ETL** | Extract, Transform, and Load | This data warehousing term refers to a process of extracting data from one source, transforming the data, and then storing it in another database. | | **FTP** | File Transfer Protocol | A network protocol that is used to transfer files between a client and a server. | | **HID** | Human Interface Device | USB-connected devices, such as barcode scanners. In Litmus Edge, an HID remains disconnected because HIDs send data only when there is data to send. | | **IoT and IIoT** | Internet of Things and Industrial Internet of Things | Communication among a large variety of devices and protocols, along with the collection of data from those devices, enables data analysis and efficient management and planning. | | **IPC** | Industrial PC | PC-based computing platform for industrial applications. | | **IPSO** | Internet Protocol for Smart Objects | This security standard for data transmission (RFC 1108) promotes IoT device interoperability to enable “smart object” capabilities. | | **LWM2M** | Lightweight Machine to Machine | The lightweight IoT device management protocol from the Open Mobile Alliance (OMA) is designed for sensor networks. See [OMA LightweightM2M (LwM2M) Object and Resource Registry](http://www.openmobilealliance.org/wp/OMNA/LwM2M/LwM2MRegistry.html). | | **MES** | Manufacturing Execution System | This system tracks the processes, data, and outcomes–from raw materials to finished goods–of a manufacturing process. This includes such things as materials tracking, management of overall equipment effectiveness (OEE), and resource scheduling. | | **MQTT** | Message Queuing Telemetry Transport | This lightweight messaging protocol uses a publish-subscribe method for connecting to sensors and devices. | | **NATS** | Neural Autonomic Transport System | This messaging platform provides a text-based publish-subscribe protocol. This NATS name compares its functions with a central nervous system. | | **NTP** | Network Time Protocol | Devices, including Litmus Edge devices, use NTP for time synchronization. | | **OAuth** | Open Authorization | OAuth 2.0, an open standard for authorization and authentication, can be configured in Litmus Edge Manager. Other authorization methods supported in Litmus Edge Manager, include:
* Query Auth (a method of signing API requests with a key) * Header Auth (HTTP authorization header) | | **OEE** | Overall Equipment Effectiveness | The standard for improving manufacturing productivity. | | **OMNA** | Open Mobile Alliance Naming Authority | The operational naming authority handles registration of assigned names and numbers to ensure interoperability of devices and software using OMA technology. | | **OPC** | Open Platform Communications | Standard interface used to communicate with industrial devices. Legacy solutions used this standard for accessing devices. As manufacturing systems evolved, a new interoperability standard, OPC UA, was developed by the [OPC Foundation](https://opcfoundation.org/about/what-is-opc/). | | **OPC DA** | Open Platform Communications Data Access | An OPC Foundation specification that defines how real-time data can be transferred between a data source and a data sink (for example: a PLC and an HMI) without either of them having to know each other's native protocol. | | **OPC UA** | Open Platform Communications Unified Architecture | This machine-to-machine protocol for industrial automation supports a Service-Oriented Architecture (SOA). | | **OTA** | Over-the-Air | Over-the-Air updates facilitate device software updates. OTA refers to the methods for distributing software, configuration settings, and even updating encryption keys. | | **PaaS** | Platform as a Service | Litmus offers Litmus Edge Manager, a cloud platform (PaaS) that provides connectivity with IoT systems to collect data that enables device monitoring and management. | | **PLC** | Programmable Logic Controller | A specialized small computer with a built-in optimized operating system used in industrial machines and sensors. | | **RBAC** | Role-Based Access Control | Enables customization of access control lists, which define who can access data, based on their assigned roles. | | **REST** | Representational State Transfer | REST provides a web service for exchanging messages between devices. Application programming interfaces (APIs) can be used to glean essential information from JSON over HTTP (refer to [REST API with JSON](https://technologyconversations.com/2014/08/12/rest-api-with-json/)). Users can use REST APIs to develop their own interfaces. | | **SCADA** | Supervisory Control and Data Acquisition | An architecture for industrial control systems that includes sensors, control relays, PLCs, computers, and applications that directly interface with managed systems. The SCADA HMI (Human-Machine Interface) enables interactivity with devices. | | **SOA** | Service-Oriented Architecture | This approach to building systems focuses on business processes for which services need to be developed and supported. This is a departure from the development of systems that focus on hardware, software, and networking resources. | | **SOAP** | Simple Object Access Protocol | SOAP provides a web service that defines a standard communication protocol for exchanging messages between devices.  | | **SSH** | Secure Shell | Protocol for secure communication over a network. | | **SSL** | Secure Socket Layer | Protocol for secure communication over a network. | | **TFA** | Two Factor Authentication | Adds an extra layer of security for user logins. | | **TLS** | Transport Layer Security | Protocol for secure communication over a network. | | **WSDL** | Web Services Description Language | XML language used to describe web services functions. See [OMA WSDL Packages](http://www.openmobilealliance.org/wp/OMNA/WSDL-packages/WSDL-packages.html). | [title] Apply a New Password Policy to a Litmus Edge Device [path] How-To Guides/Litmus Edge Manager Admin Console Guides/ In this use case, you will create a new password policy in Litmus Edge Manager. Then you will apply it to a Litmus Edge device and try to change the password to confirm it adheres to the new password policy. # Before You Begin If you haven't yet connected your Litmus Edge instance to Litmus Edge Manager, see [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB). # Step 1: Create a New Password Policy in Litmus Edge Manager In this step, you will create a new password policy in Litmus Edge Manager. The created policy will be later applied to a Litmus Edge instance. **To create a new password policy:** 1. Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: **https\://\[LEM IP address]:8446**. 2. From the navigation panel, select **Edge Devices**. The *Edge Software Update* pane appears. 3. From the Edge Device navigation sub-panel, select **Edge Password Policies**. The *Edge Password Policies* pane appears. 4. Expand the *Default password policy* section and click **Copy**. The *Create Password Policy* dialog appears. 5. In the **Policy Name** field, enter **New Password Policy**. 6. In the **Description **field, enter a description. 7. Click **Save**. 8. Click the created **New Password Policy **box*. *The password policy box expands with additional fields. 9. For the following fields, enter the following details: - **Minimum password length**: 8 - **Maximum password length**: 16 - **Auto generated password length**: 12 - **Minimum uppercase characters**: 1 - **Minimum lowercase characters**: 3 - **Minimum number of digits**: 1 - **Special characters**: \~!@ - **Minimum special characters**: 1 ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/S4Cfz28c3HYDGhPe5Q4K2_image.png" size="80" width="1765" height="791" position="center" caption="Password policy parameters" showCaption="true"} # Step 2: Apply the Created Policy to a Litmus Edge in Litmus Edge Manager From the previous step's created policy, you will then apply the policy settings to a selected Litmus Edge instance. **To apply the password policy to a Litmus Edge instance:** 1. Log in to Litmus Edge Manager. 2. Select a company. The *Projects* pane appears. 3. Select the appropriate project. 4. The *Dashboard* pane appears for the project. 5. From the Navigation panel, select **Edge Devices**. The *Edge Devices* pane appears. 6. Click an edge device **ID** link in the Edge Devices pane. The selected *Edge Device Details* page open with the **Info** tab. 7. Click the **Policy** tab. 8. From the *Selected Policy* dropdown menu, select the created **New Password Policy **from Step 1. 9. Click **Save**. - If successful, the bottom right corner will display *Policy for device saved.* - If unsuccessful, the Litmus Edge's current password does not adhere to the password policy as indicated by **New Password Policy**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/5lTYKLXgIZqzcO010BnYh_image.png" size="80" width="1765" height="791" position="center" caption="New Password Policy applied to a Litmus Edge" showCaption="true"} # Step 3: Confirm Received Policy Settings Change in Litmus Edge After applying a password policy, you will then access the Litmus Edge instance that just received the policy. From there, you will then confirm the Litmus Edge instance has successfully received the password policy's settings. **To confirm the received password policy changes**: 1. Log in to Litmus Edge. 2. From the navigation panel, navigate to **System **>** Policy Management**. The *Policy Management *pane appears. 3. From the *Password Policy* section, you can see the received password policy. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/dIM8tt58km2jTblAqhqY0_image.png" size="80" width="1765" height="791" position="center" caption="Received password policy" showCaption="true"} # Step 4: Attempt to Change Litmus Edge Password to Verify Password Policy Finally, after receiving the password policy settings, you will attempt to change the password of the Litmus Edge instance to confirm the password policy settings. **To attempt to change the Litmus Edge instance password**: 1. Log in to Litmus Edge. 2. Click your user icon in the top-right corner and select **User Profile**. 3. In the *New Password* and *Confirm New Password* field, enter a password that goes against **New Password Policy**. You will see the new requirements being listed. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/V3j6PjCSnJ9qvWwCLG3ad_image.png" size="80" width="1765" height="791" position="center" caption="Attempting to change password" showCaption="true"} [title] Litmus Edge Manager 2.3.5 [path] Product Updates/2022/ Release Date: August 1, 2022 ## Enhancements and Features The following features and enhancements are included in this software release: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------------------------- | | For pre-signed URLs, port 443 can be used in lieu of port 8446. This prevents issues with self-signed certificates and SSL on non-standard ports. | | **Edge Devices:**
* Litmus Edge Device Support Bundle files can now be downloaded. | ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Applications:**
* Marketplace applications can now be deployed to multiple edge devices concurrently. Previously, deployment had to be done consecutively. | [title] Litmus Edge Manager 1.9.0 [path] Product Updates/2020/ Release Date: October 16, 2020 ## Enhancements and Features The following issues that existed in one or more previous releases have been resolved: | **Description** | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **New - Data Lifecycle Management:**
* Data LifeCycle Management allows user to manage collected data for analysis and trace it to the point of storage or cleaning * Users can monitor data usage and download collected data in csv format * Users can define policy to archive and purge data | | **New - Trigger alert on Device Status:**
* Users have ability to create incidents and send alerts based on changing device online status | | **Compatibility with both Litmus Edge 2.6.x and 3.x:**
* Litmus Edge Manager-1.9.0 can manage both Litmus Edge 2.6.x and 3.x | | **Miscellaneous:**
* Litmus Edge friendly name available on Litmus Edge Manager * Health check on minio before domain name change * Various bug fixes * General UI and UX improvements | ## Known Issues The following issues are unresolved in this release: | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | - Failure on all file upload of Litmus Edge on Litmus Edge Manager Admin Console on FireFox browser with self-signed certificate - Upgrade Litmus Edge Manager-1.8.4 to 1.9.0 isn't compatible | [title] Litmus Edge Manager 2.14.0 [path] Product Updates/2023/ Release Date: September 26, 2023 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Enhancements and Features | **Description** | | ----------------------------------------------------------------------------------------------- | | **Integration**:
* Bridge performance between MQTT and Kafka is now improved. | | **Alerts:**
* You can now customize the email message and subject for metric alerts. | | **Licenses:**
* You can now delete existing Litmus Edge Manager licenses. | ## Resolved Issues | **Description** | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Settings**:
* Fixed issue with the firewall rule for NTP not being applied after installing or upgrading Litmus Edge Manager. | | **Users**:
* Fixed issue with insecure password policies being accepted. * When you change a user password and don't meet all the policy requirements, an error message now displays informing the user with these specific details. | | **Companies:**
* Fixed issue with users without admin privileges being able to add and delete companies. | | **Alerts:**
* Fixed issue with email alert notifications not working. * Fixed issue with a `SendAsDenied` error displaying when using a Microsoft Outlook account to send metric alerts and the authentication address is correct. * Fixed issue with triggers creating incidents for DeviceHub online status and automatically resolving when the status is still offline. | | **Templates:**
* Fixed issue with template files allowing more than 512 characters in the* Description* field. | | **Marketplace:**
* Fixed issue with Marketplace applications not launching successfully in the following scenario: - In Litmus Edge Manager version 2.2.2, add a new catalog and import an application. - Upgrade Litmus Edge Manager from 2.2.2 to 2.12.0. - Activate a Litmus Edge version 3.5.5. - Launch the imported application in the activated Litmus Edge 3.5.5. | ## Deprecated Components and Features | **Description** | | ----------------------------------------------- | | - GOM (Graph-over-MQTT) is no longer supported. | [title] Litmus Edge Manager 2.1.1 [path] Product Updates/2021/ Release Date: May 27, 2021 ## Resolved Issues The following issues that existed in one or more previous releases have been resolved: | **Description** | | ------------------------------------------------------------------------------ | | Fixed issue with configuration and data export/import feature on admin console | ## Known Issues The following issues are unresolved in this release: | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | - Failure on all file upload of Litmus Edge on Litmus Edge Manager Admin Console on FireFox browser with self-signed certificate - Parametrized templates are not supported for instance level templates - DLM archive/purge doesn’t affect on the current time period (current month) - Admin Dashboard usage stats inconsistent to DLM statistics - Analytics templates are not supported | [title] 2020 [path] Product Updates/ - [Litmus Edge Manager 1.9.2](docId\:ZDTnpcKRr_gbtoiXkI2F5) - [Litmus Edge Manager 1.9.1](docId:_t-YbzXPGpm8yXY1CdkN_) - [Litmus Edge Manager 1.9.0](docId:45lqlV0QEXBJmFO3_dV-W) - [Litmus Edge Manager 1.7.2](docId\:TuzFtMP-q2EhFaNal3AkZ) [title] How to Setup Git Provider Integration [path] How-To Guides/Litmus Edge Manager Admin Console Guides/ Git Provider is a one-directional integration that synchronizes Litmus Edge template files from your edge devices to a Git repository of your choice (GitHub, GitLab, or Azure DevOps). This integration enables you to maintain version control, track configuration changes, and ensure compliance across your distributed edge deployments. When you configure Git Provider, Litmus Edge Manager (LEM) automatically pushes template updates to your Git repository based on a schedule you define (hourly, daily, weekly, or monthly) or when edge devices are backed up. Before you begin, decide how to organize your repositories. You can create: - One repository with folders mirroring your company or project structure - Separate repositories per project or company :::hint{type="info"} **Note:** We recommend using a private repository to protect your edge configuration data. ::: The examples in this topic use GitHub as a repository. :::hint{type="info"} **Note:** Also see [Git Provider](docId\:AC86nRgXAxKany3KRWrmm) for additional overview and workflow information. ::: ## Prerequisites Before you configure Git Provider integration, ensure you have: - Administrative access to Litmus Edge Manager Admin Console - A GitHub, GitLab, or Azure DevOps account with repository creation permissions - Appropriate permissions on your Git repo ## Step 1: Create a Git Repository To setup a GitHub repository: 1. In GitHub, create a new public or private repository. We recommend adding a private repo. The example repo here is named `le-templates`. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/QQ1ioFXXXGHI9WmYb3CUg_image.png" size="80" width="1887" height="690" position="flex-start" darkWidth="1887" darkHeight="690" showCaption="false" indent="2"} 2. Record the repository name. ## Step 2: Configure Git Provider in LEM To setup the LEM and Git integration: 1. In LEM Admin Console, navigate to **Integration** > **Git Provider**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/5_q9UpyHFiV5ihsLqsuO6_image.png" size="80" width="1354" height="523" position="flex-start" darkWidth="1354" darkHeight="523" showCaption="false" indent="2"} 2. In **Provider Type**, select one of GitHub, GitLab, or Azure DevOps. This example uses GitHub. 3. In SSH URL, provide the GitHub URL with the following syntax: `git@github.com:/.git`. For example:`git@github.com:gpm-litmus/lem-template.git` ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/TOlrFRNXgaDmBCpZHAq9h_git-provider-01.png" size="100" width="1302" height="542" position="flex-start" darkWidth="1302" darkHeight="542" showCaption="false" indent="2"} 4. Copy the value from **SSH Public Key**. ## Step 3: Add the Deploy Key to Your Git Repository 1. In GitHub, add the public key as a deploy key: 1. Navigate to **Settings** > **Deploy keys** and click **Add deploy key**. 2. Provide a key name in **Title** and paste the SSH public key in **Key**. 3. Select **Allow write access** and click **Add key**. 2. In LEM Admin Console and in **Integration** > **Git Provider**, click **Validate**. If successful, the `Repository access successful` message displays. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/fB1AixmYFl0aEu2GalobS_image.png" size="40" width="539" height="231" position="flex-start" darkWidth="539" darkHeight="231" showCaption="false" indent="2"} 3. Close the success message and click **Save**. ## Step 4: Configure Synchronization Settings To configure synchronization settings: 1. Navigate to **Edge Devices** > **Edge Git Integration**. Verify that edge devices populate on the page. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/FBIkufmclqFIwHi5c-fFq_image.png" size="80" width="1907" height="614" position="flex-start" darkWidth="1907" darkHeight="614" showCaption="false" indent="2"} 2. In **Synchronization Frequency**, specify how often Git synchronization occurs: hourly, daily, weekly, or monthly. Syncs occur at 00:00 (UTC) daily, weekly on Mondays, and monthly on the first day of the month. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/WZTElZiXJOcFjt2NnCgWk_image.png" size="40" width="360" height="172" position="flex-start" darkWidth="360" darkHeight="172" showCaption="false" indent="2"} ## Step 5: Configure Synchronization Settings Next configure in the integration for edge devices belonging to your company. Here you also view the number edge devices and synced devices, last sync and commit ID, and integration status. You set tracking at the project level. The following columns display in Project Tracking: | **Field** | **Description** | | ------------------- | ----------------------------------------------------------------------------------------------------------------- | | Company | Company to which the devices belongs | | Project | Project to which the devices belong | | Track | Enable to push changes to Git based on the selected synchronization frequency | | Sync on Backup | Enable to push changes to Git when the device is backed up | | Edge Devices | Number of devices in the project | | Synced Devices | Number of devices that have been synchronized | | Last Sync Time | The last time that a synchronization was performed from all edge devices in the current project to LEM | | Last Commit | Git commit hash which is a unique identifier representing a specific commit in a Git repository | | Status | Status of the integration: `NEW`, `WAITING`, `RUNNING`, `CANCELING`, `SUCCESS`, `ERROR`, or `CANCEL` | | Action | Options to enable or disable tracking on the predefined schedule, on device backup, or to run a manual synch | To configure the integration for edge devices: 1. Navigate to **Edge Devices** > **Edge Git Integration**. 2. In **Project Tracking**, set the synchronization frequency for devices in a company. To sync templates: - Based on the synchronization frequency, select **Track**. - When the device is backed up, select **Sync on Backup**. 3. To enable the integration, in the **Actions** shortcut menu, select **Enable Sync on Backup** or **Run Manual Sync**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/aSP-nXjQHZWizMYVWQFEp_image.png" size="40" width="481" height="259" position="flex-start" showCaption="false" indent="2"} To test the sync, click **Run Manual Sync**. In Git, verify that the commit appears and contains the correct JSON template file. [title] Issues with Custom SSL Certificates [path] Troubleshooting/ When setting up a custom SSL certificate in the [Domain/SSL](docId\:MC8Z1bK3yWcKQq4-kupCv) settings in the Litmus Edge Manager Admin Console settings, it's important not to use a private key with a passphrase. If a user-defined SSL certificate uses a private key with a passphrase, it can cause Litmus Edge Manager to become unresponsive. ## Solution To resolve this, use a private key with no passphrase. :::hint{type="info"} **Note:** The SSL certificates are normally cached in the browser and server sides. If you are going to make any changes to the certificates, you might need to wait or restart the server and/or refresh the browser. ::: [title] 2024 [path] Product Updates/ - [Litmus Edge Manager 2.22.4](docId\:dt3SuJXBt0RHEpPKbXvSk) - [Litmus Edge Manager 2.22.2](docId\:HmmcR3FO95kT9ayZ1q22g) - [Litmus Edge Manager 2.16.7](docId\:BOWpgt0nj8C_j3POfR3NL) - [Litmus Edge Manager 2.16.6](docId\:Ep32wZrUT_xNKFa816QXn) - [Litmus Edge Manager 2.16.5](docId\:AtZuOMClMxpjyf8uRzHDx) - [Litmus Edge Manager 2.16.4](docId\:pOup9KgdIYNI1QANkfjAO) - [Litmus Edge Manager 2.16.0](docId\:NDu-Qgze0fvQjiJcsQwKE) [title] Litmus Edge Manager 2.31.6 [path] Product Updates/2026/ Release Date: August 10, 2026 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Resolved Issues | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Devices:**
* Fixed issue where the **Manage** tab for an offline device shifted and partially obscured the left side of the page. * Fixed an issue where a Litmus Edge session opened remotely could expire after a few minutes of inactivity. Changes made while editing were not saved and no timeout warning or session-expiry prompts displayed. The session now remains active for as long as the device UI is open. | | **Events:**
* Fixed a `MEMORY_LIMIT_EXCEEDED` error on the Events page caused by reading a wide attributes column. | | **Digital Twins:**
* Fixed an issue where images (such as PNG files) added to a Digital Twins model were not synchronized to edge devices. | | **License Server Management:**
* Fixed an issue where you could not change a device from Node Locked to Site License. | | **System:**
* Fixed issue where exporting settings data from **System** > **Export/Import Data** produced an error and the export did not occur. | | **MQTT:**
* Fixed an issue where an anonymous client could connect to the MQTT broker without authentication. | [title] Litmus Edge Manager 2.31.7 [path] Product Updates/2026/ Release Date: September 5, 2026 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Resolved issues | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Applications:**
* Fixed issue where Docker published a container on a random host port when a Compose file used a variable in short syntax, such as `${UI_PORT}:3130`. The catalog dropped the variable and stored an empty host port. After an upgrade, resave the Compose file for any application deployed before this fix. Existing releases still contain the empty port. * Fixed issue where Litmus Edge Manager (LEM) attached an application to a duplicate of the intended network. This occurred when an external network in a Compose file used a `name:` override that differed from its section key. If the service also requested a static IP address, Docker rejected the deployment because the duplicate had no user-configured subnet. Without a static IP request, the container ran on the wrong network and reported no error. * Fixed issue where adding an Azure Container Registry (ACR) provider in the Marketplace returned `Failed to add repository details`. This occurred because the registry address was not passed during ACR login. | | **System:**
* Resolved the CVE-2026-10050 vulnerability. | [title] Litmus Edge Manager Admin Console Guides [path] How-To Guides/ [title] Litmus Edge Manager 2.0.0 [path] Product Updates/2021/ Release Date: January 31, 2021 ## Enhancements and Features The following issues that existed in one or more previous releases have been resolved: | **Description** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **New - Advanced dashboarding capabilities with Grafana:**
* Advanced dashboard using integrated Grafana * Bind projects, IPSO objects and tags with dashboard template * Added sample dashboards * Access defined to dashboard using keycloak | | **New - Zerotier Network Management:**
* Allows user to create set Zerotier token for Litmus Edge Manager instance | | **New - Introduction of Experimental Features:**
* Added few experimental features with toggle mode to enable/disable it on UI - Digital Twin - Edge Events Management - OM Registry Management | | **New - Added Edge event alerts:**
* Added Litmus Edge events as source for alert generation | | **New - Manage Edge event forwarding:**
* Added support to enable edge events from Litmus Edge Manager for connected devices | | **New - Show Hashing on upgrade image:**
* Litmus Edge Manager web UI shows SHA256/MD5 hash after software upgrade image upload | | **New - Configurable Password Policy for Edge:**
* Admin user can configure password policy for edge devices from Litmus Edge Manager | | **New - Support to upload images from URL:**
* Added support to upload Litmus Edge and Litmus Edge Manager images using a signed link | | **Improved Alert trigger notifications:**
* Included new variables to improve alert subject and message * Added system incident to show any issues with sending alerts | | **Realtime status update of Marketplace Application:**
* Litmus Edge Manager supports real time status update of marketplace applications with event forwarding enabled. | | **Updated version of Kafka:**
* Updated kafka to version 2.6 | | **UI/UX Improvements:**
* Improved input fields for password through the system | | **Deprecated feature/component:**
* Reporting using Insights are deprecated as Grafana is integrated for dashboarding | ## Known Issues The following issues are unresolved in this release: | **Description** | | -------------------------------------------------------------------------------------------------------------------------------- | | - Failure on all file upload of Litmus Edge on Litmus Edge Manager Admin Console on FireFox browser with self-signed certificate | [title] 2026 [path] Product Updates/ - [Litmus Edge Manager 2.31.7](docId\:pELk2amA2PV6uFPVnwvGq) - [Litmus Edge Manager 2.31.6](docId:_LtDrtc5_f4yjFZsQmI_c) - [Litmus Edge Manager 2.31.5](docId\:lecG-G-zhxdDJGaIlfzrg) - [Litmus Edge Manager 2.31.3](docId:1YHZZYvVS8bJmEaW1OXAI) - [Litmus Edge Manager 2.31.2](docId:3j8fxbUExAvQMiKwdtzVv) - [Litmus Edge Manager 2.31.1](docId\:LxiCGMIG-1l4gRkH0Sxz2) [title] Generate Comprehensive NL License Summary Report [path] How-To Guides/Litmus Edge Manager Admin Console Guides/ You can create a summary report for Node-Locked (NL) licenses in Litmus Edge Manager. NL licenses are special permissions that allow users to access Litmus Edge instances from various companies and projects. # Before You Begin - Read more about the information you can generate in [Node-Locked Licenses](docId\:c0-d2jkjFVytbWDoL9FRr) in Litmus Edge Manager. # License Report Contents The Node-Locked (NL) license reports will display the license usage by Edge Devices. Here is a sample of the **Node-Locked (NL) License Report** with key sections included: ::File{src="https://archbee-doc-uploads.s3.amazonaws.com/Q116WJTAr1sefeVNvMCF9-XwUSymHxIqlcT16OXsyZr-20250421-210334.csv" label="NL_license_export_sample.csv"} # Step 1: Access the Node-locked Licenses Pane To find the settings, follow these steps: 1. Navigate to **Litmus Edge Manager Admin Console**. 2. Go to **Edge Devices** > **Node-locked Licenses **section from the left menu. 3. In the *Node-locked Licenses* section, you will see the license usage of Edge Devices. ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/LN1x_FtqY2vMWYNkJ3XzB_image.png) # Step 2: Generate Node-Locked Licenses Report You can see a summary of your node-locked licenses on the Node-locked Licenses page. You can also perform several actions on this page. See [Node-Locked Licenses](docId\:c0-d2jkjFVytbWDoL9FRr) for more details. To export a copy of the report, click on **Generate a Report**, and a summary copy of your node-locked licenses will be saved locally on your system. :::hint{type="info"} **Note:** The filters you have applied may affect the report generation, and you can search by *Network Name*, *Subnet*, or *Status *before generating. ::: # Step 3: View Report Contents Below is the information you may find in every Node-Locked license report: ![](https://archbee-image-uploads.s3.amazonaws.com/SSUUxKZUk9bFTEPNn_6Zo/21AUt5JGcThr0czrklPiC_image.png) | Column | Details | | ------------------------ | ------------------------------------------------------------------------------------------------ | | **Company name** | The name of the company that the license belongs to. | | **Project name** | The name of the project where the license is being used. | | **Project ID** | A unique identification number for the project. | | **Device ID** | A unique identification number for the specific device using the license. | | **Device name** | The name given to the device. | | **Device friendly name** | A more user-friendly name for the device. | | **Device MAC address** | The unique hardware address of the network interface of the device. | | **License key** | A unique code that activates the software on the device. | | **SKU** | The Stock Keeping Unit, which is a code that identifies the specific type of license. | | **Activation date** | The date when the license was activated on the device. | | **Expiry date** | The date when the license will no longer be valid. | | **Expiry feature date** | Sometimes, specific features of the license might expire on a different date. | | **Is core** | Indicates if this license is a core license for the device. It can be "**TRUE**" or "**FALSE**". | | **Is trial** | Indicates if the license is a trial version. It can be "**TRUE**" or "**FALSE**". | | **Status** | The current status of the license. For example, "**EXPIRED**", "**OK**", or "**NEW**". | [title] Static IP Address Error [path] Troubleshooting/ When following the steps to [Set a Static IP Address](docId\:eu1MB0qeHF67YNC6i3ohh), you may see the following error message. :::BlockQuote If you face an error like this Error occured: Failed to set network interface configuration: Network interface configuration error: \*\* (generate:33344): WARNING \*\*: 12:51:35.007: Permissions for /etc/netplan/50-cloud-init.yaml are too open ::: # Resolution Change permissions on the config files with the following command. :::BlockQuote sudo chmod 600 /etc/netplan/\*.yaml ::: [title] Litmus Edge Manager 2.16.6 [path] Product Updates/2024/ :::hint{type="warning"} **Important**: For a seamless upgrade experience in upcoming releases, it's crucial to upgrade from version 2.16.4 to 2.16.6 before making any further upgrades. Skipping the initial upgrade to version 2.16.4 and then 2.16.6 may disrupt the upgrade process, and is therefore not recommended. ::: Release Date: July 3, 2024 ## Resolved Issues | **Description** | | ------------------------------------------------------------------------------------------------ | | **Security: **
* Addressed security vulnerabilities associated with CVE-2024-6387. | | **Integration:**
* The Alertmanager version has been rolled back from `0.27.0` to `0.26.0`. | [title] Litmus Edge Manager 2.22.5 [path] Product Updates/2025/ Release Date: Feb 14, 2025 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Resolved Issues | Description | | ---------------------------------------------------------------------------------------------------------------------- | | **Grafana Dashboard:**
* Fixed issue where the friendly name was not displayed in the Grafana dashboard dropdown. | [title] Litmus Edge Manager 2.26.3 [path] Product Updates/2025/ Release Date: August 19, 2025 Review the current list of [Limitations](docId\:MRg6GMxJ4s8e56y0bNGXM). ## Resolved Issues | Description | | ------------------------------------------------------------------------- | | **Security:**
* Fixed issues with upstream security vulnerabilities. | [title] Litmus Edge Manager 1.9.3 [path] Product Updates/2021/ Release Date: January 29, 2021 ## Enhancements and Features The following issues that existed in one or more previous releases have been resolved: | **Description** | | -------------------------------------------------- | | **CVE fix:**
* Fix included for CVE-2021-3156 | ## Known Issues The following issues are unresolved in this release: | **Description** | | ------------------------------------------------------------------------------------------------------------------------------ | | Failure on all file upload of Litmus Edge on Litmus Edge Manager Admin Console on FireFox browser with self-signed certificate | [title] Limitations [path] Resources/ | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Edge Devices:**
* There may be issues when trying to create a backup for an edge device. | | **Templates:**
* No notification appears when creating a template from a Litmus Edge device with a trial license. | | **Applications:**
* When cloning a Marketplace application release to the latest version tag, the application container stops and must be manually restarted. As a workaround, create a new application release configuration and submit the release instead of cloning. | | **System**:
* You may not be able to successfully archive files that are larger than 700MB. | [title] Upgrade from Litmus Edge Manager 2.16.0 to 2.16.4 [path] Troubleshooting/ If you are facing issues during an upgrade of Litmus Edge Manager version 2.16.0 to 2.16.4 (only for uploading a UPD file via browser from the local system), complete the following steps. 1. SSH into the Litmus Edge Manager instance and enter the following commands. `sudo mkdir -p /var/lib/lem/tmp` `sudo nano /etc/systemd/system/lem-admin.service` 2. Insert the following line. `Environment="JAVA_TOOL_OPTIONS=-Djava.io.tmpdir=/var/lib/lem/tmp"` after `Group=root` 3. Enter the following command. `sudo systemctl daemon-reload; sudo systemctl restart lem-admin.service` 4. Upgrade Litmus Edge Manager to version 2.16.4. See [Software Update](docId\:hzLOrWMFP3cGa8OvH_njo) to learn more. [title] 2025 [path] Product Updates/ - [Litmus Edge Manager 2.31.0](docId\:za5q8bIG19s3wl6U1iDXW) - [Litmus Edge Manager 2.26.4](docId:4RN_DcDya8O8qpxCT3XOm) - [Litmus Edge Manager 2.26.3](docId\:aAeHPJmM-9lunDetZUVNu) - [Litmus Edge Manager 2.26.2](docId\:tR8YKPvVPibZIFqN1IhFq) - [Litmus Edge Manager 2.26.1](docId\:Kht3hBpMY5GEFWXUJSbDO) - [Litmus Edge Manager 2.22.5](docId\:yt3ifVto8sYey7hYXn0nW) [title] 2022 [path] Product Updates/ - [Litmus Edge Manager 2.7.0](docId:93WCl7gzvUgFCQT3Sc0l0) - [Litmus Edge Manager 2.5.3](docId\:Mxtz-qz5KVjR28VZ2-DYh) - [Litmus Edge Manager 2.5.1](docId\:BVAQTHQyqfO_sOP4bc3lI) - [Litmus Edge Manager 2.3.5](docId:9ZmrqCyKMcabtXmBLeCdG) - [Litmus Edge Manager 2.3.3](docId:1pt2TVUNYxBNkoorWzTwh) - [Litmus Edge Manager 2.3.1](docId\:eB0HVyA8qLgNpuxuAiyMo) [title] 2021 [path] Product Updates/ - [Litmus Edge Manager 2.2.2](docId\:KHcYowd99-1TF0t4WpzuA) - [Litmus Edge Manager 2.1.1](docId\:w5XkEWypUJMNXnoSOpRRI) - [Litmus Edge Manager 2.1.0](docId\:VmdnGLBprUvMAIec8Zfsr) - [Litmus Edge Manager 2.0.0](docId\:Vn1qQH16yUn2eXi6fPFOQ) - [Litmus Edge Manager 1.9.3](docId\:TMwTQK1-b4YbzH_ydqLte) [space] Litmus MCP Server (/litmus-mcp-server) [title] Architecture [path] / The Litmus MCP Server is two cooperating processes packaged in one container. ## Processes | Process | File | Port | Role | | ---------- | ------------------- | ---- | ------------------------------------------------------------------------------------------------------------------- | | MCP server | `src/server.py` | 8000 | Implements the MCP protocol over SSE. Exposes 57 tools and a set of `litmus://docs/*` resources. | | Web client | `src/web_client.py` | 9000 | FastAPI app: chat UI, config pages, LLM streaming, multi-instance management. Launches `server.py` as a subprocess. | Both ports come from a single Docker image. The Web UI is optional; clients can hit the SSE endpoint directly without ever touching port 9000. ## Request flow (Web UI) ```javascript Browser | | POST /chat v web_client.py ---> client_utils.process_streaming_query | | anthropic.messages.stream() / OpenAI / Gemini v LLM provider | | tool_use events v session.call_tool(name, args) | v MCP server (port 8000) | v server.py handle_call_tool | v tools/_tools.py | v Litmus Edge REST / NATS / InfluxDB ``` ## Request flow (external MCP client) ```javascript Claude Desktop / Cursor / VS Code / Windsurf / Claude Code | | SSE (with headers) v MCP server (port 8000) | v tools/_tools.py | v Litmus Edge REST / NATS / InfluxDB ``` ## Authentication The server is stateless. Every tool call receives a `request` object and pulls credentials from headers (SSE mode) or environment variables (STDIO mode) at call time, via helpers in `src/utils/auth.py`: - `get_litmus_connection(request)` - Litmus Edge REST/SDK - `get_nats_connection_params(request)` - NATS broker - `get_influx_connection_params(request)` - InfluxDB This means a single MCP server can be shared across many users, each presenting their own headers. There is no server-side session, no shared credentials. ## Multi-instance edge support The Web UI lets you register multiple Litmus Edge devices and switch between them. Internally, instances live in `.env` as: ```javascript EDGE_INSTANCE_1_URL=... EDGE_INSTANCE_1_CLIENT_ID=... EDGE_INSTANCE_1_CLIENT_SECRET=... EDGE_INSTANCE_1_NAME=... EDGE_INSTANCE_2_URL=... ACTIVE_EDGE_INSTANCE=1 ``` The active instance's credentials are mirrored into the canonical `EDGE_URL`, `EDGE_API_CLIENT_ID`, `EDGE_API_CLIENT_SECRET` keys so the rest of the system needs no awareness of multi-tenancy. See [Multi-Instance Edge](#). ## Transport modes | Mode | When to use | Auth source | | ------------- | ---------------------------------------------------- | --------------------------- | | SSE (default) | Remote or shared MCP server, any HTTP-capable client | HTTP headers per connection | | STDIO | Single-user local install with Claude Desktop | Environment variables | STDIO is opt-in via `ENABLE_STDIO=true` in `src/config.py` or environment. ## Source layout ```javascript src/ ├── server.py MCP server entrypoint, SSE setup ├── web_client.py FastAPI app, all web routes ├── client_utils.py LLM streaming, tool-call loop ├── env_config.py .env read/write, path constants ├── config.py Ports, SSL, NATS/InfluxDB defaults ├── conversation.py In-memory chat history ├── utils/ │ ├── auth.py Header -> connection params │ └── formatting.py Tool response shape helpers └── tools/ ├── devicehub_tools.py ├── dm_tools.py ├── marketplace_tools.py ├── data_tools.py ├── digitaltwins_tools.py ├── system_tools.py ├── lem_tools.py └── resource_tools.py MCP Resources (live docs.litmus.io) ``` Each `*_tools.py` exports a `TOOLS = [...]` list of dicts. `server.py` concatenates them and dispatches by name. [title] MCP Resources [path] / The Litmus MCP server exposes a set of `litmus://docs/
` URIs as MCP **Resources**. MCP-aware clients can read these URIs on demand, fetching live content directly from [docs.litmus.io](https://docs.litmus.io). This means an LLM client can pull current Litmus reference material into its context without you copying and pasting documentation. ## Why Resources MCP tools are for actions the model takes. MCP resources are for static (or live-fetched) reference material the model reads. By exposing Litmus docs as resources, an MCP client can: - Pull driver-specific documentation when configuring a new device. - Read the DeviceHub or Digital Twins user guide when the model is unsure how a feature works. - Confirm the current behavior of a Litmus Edge component before suggesting changes. ## Available resources | URI | Source page | | --------------------------------------- | --------------------------------------------------------------------------------- | | `litmus://docs/overview` | [docs.litmus.io](https://docs.litmus.io) | | `litmus://docs/edge` | `/litmusedge` | | `litmus://docs/edge/devicehub` | `/litmusedge/product-features/devicehub` | | `litmus://docs/edge/digitaltwins` | `/litmusedge/product-features/digital-twins` | | `litmus://docs/edge/datahub` | `/litmusedge/product-features/datahub` | | `litmus://docs/edge/marketplace` | `/litmusedge/product-features/applications` | | `litmus://docs/edgemanager` | `/edgemanager` | | `litmus://docs/edgemanager/marketplace` | `/edgemanager/lem-user-ui/product-features/marketplace-catalogs-and-applications` | | `litmus://docs/edgemanager/grafana` | `/edgemanager/lem-user-ui/product-features/grafana-dashboards` | | `litmus://docs/solutions` | `/solutions` | The full list is defined in `src/tools/resource_tools.py`. ## How a client uses them Standard MCP protocol: 1. Client calls `list_resources` -> server returns the URIs above. 2. Client calls `read_resource(uri)` with one of them -> server fetches the page via `httpx`, returns the rendered text. Different MCP clients surface resources differently. Some expose them via a context menu ("attach resource"), some let the model autonomously call `read_resource` mid-conversation, some require manual selection. ## Live vs cached Each `read_resource` call performs a fresh `httpx` GET against `docs.litmus.io`. No caching, no bundling. If the docs are updated, the next read picks up the changes. ## See also - [Tools Reference](#) for the action-oriented half of the MCP surface. [title] Device Identity [path] Tools/ # Device Identity Read and write the Litmus Edge device's friendly name. | Tool | Description | | ------------------------------ | --------------------------------------------------------------- | | `get_litmusedge_friendly_name` | Get the human-readable name assigned to the Litmus Edge device. | | `set_litmusedge_friendly_name` | Update the friendly name. | ## When to use which - **Display purposes:** `get_litmusedge_friendly_name` whenever you need a label rather than a URL or IP for the edge. - **Provisioning / commissioning:** `set_litmusedge_friendly_name` once, typically at first install. ## Requirements - `EDGE_URL`, `EDGE_API_CLIENT_ID`, `EDGE_API_CLIENT_SECRET`. ## Related - [Cloud / LEM Activation](#) - once an edge has a friendly name, registering it with LEM is the typical next step. [title] Getting Started [path] / Run the Litmus MCP Server in Docker and start using it in under a minute. ## Minimal: SSE only ```bash docker run -d --name litmus-mcp-server \ -p 8000:8000 \ ghcr.io/litmusautomation/litmus-mcp-server:latest ``` The SSE endpoint is now at `http://localhost:8000/sse`. Wire it into an MCP client (see [Clients](#)) and you're done. ## With the built-in Web UI If you want the bundled chat interface (no MCP client required), expose port `9000` and provide one LLM API key: ```bash docker run -d --name litmus-mcp-server \ -p 8000:8000 -p 9000:9000 \ -e ANTHROPIC_API_KEY= \ ghcr.io/litmusautomation/litmus-mcp-server:latest ``` Open `http://localhost:9000`, add a Litmus Edge instance from the config page, and start chatting. ## Choose your path | If you want to... | Go here | | ----------------------------------------------------------------- | ----------------------------- | | Connect Claude Desktop, Cursor, VS Code, Windsurf, or Claude Code | [Clients](#) | | Chat from the browser without installing a client | [Web UI](#) | | Keep your settings across container replacement | [Persistent Configuration](#) | | Run the server locally (no Docker) for STDIO clients | [STDIO Mode](#) | | Understand what credentials to send | [Headers Reference](#) | | See the full tool catalog | [Tools Reference](#) | ## ARM64 hosts The image is built for `linux/amd64`. On Apple Silicon or other ARM64 machines, pin the platform: ```bash docker run -d --name litmus-mcp-server \ --platform linux/amd64 \ -p 8000:8000 \ ghcr.io/litmusautomation/litmus-mcp-server:latest ``` See [Docker](#) for additional options. [title] LEM Bridge [path] Tools/ # LEM Bridge The LEM Bridge tools let you reach a specific edge **through** a Litmus Edge Manager tenant, without switching the MCP server's active edge instance. | Tool | Description | | ----------------------------------- | ------------------------------------------------------------------------------- | | `lem_bridge_list_devicehub_devices` | List DeviceHub devices on a specific edge by tunneling through LEM. | | `lem_bridge_get_le_info` | Identity info (friendly name, cloud activation) for an edge via the LEM bridge. | ## When to use which - **Cross-fleet inspection:** you have a LEM tenant with many edges, and you want to inspect one of them without changing the active `EDGE_URL` / `EDGE_API_CLIENT_ID` / `EDGE_API_CLIENT_SECRET` your MCP server is configured for. - **Fleet automation:** loop over devices returned by `lem_list_devices`, calling bridge tools per device. Bridge tools do **not** mutate the MCP server's active instance, so they're safe to run concurrently with normal tool calls. ## Required arguments Every bridge tool takes: - `project_id` - LEM project id. - `device_id` - LEM device id (target edge). ## Requirements - `EDGE_MANAGER_URL`, `EDGE_API_TOKEN`. See [LEM](#) for the full set. - `VALIDATE_CERTIFICATE=true` if the LEM tenant uses a publicly verifiable cert and you want strict TLS. ## Related - [Litmus Edge Manager (LEM)](#) - fleet-wide LEM operations. - [Multi-Instance Edge](#) - alternative pattern when you control a small, named set of edges directly. [title] VS Code Copilot [path] Clients/ # VS Code / GitHub Copilot Configure [VS Code with GitHub Copilot](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) to use the Litmus MCP server over SSE. ## 1. Run the server ```bash docker run -d --name litmus-mcp-server \ -p 8000:8000 \ ghcr.io/litmusautomation/litmus-mcp-server:latest ``` ## 2. Add the server config Two options. ### Option A: User Settings (JSON) Open **Preferences -> User Settings (JSON)** and add: ```json { "mcpServers": { "litmus-mcp-server": { "url": "http://:8000/sse", "headers": { "EDGE_URL": "https://", "EDGE_API_CLIENT_ID": "", "EDGE_API_CLIENT_SECRET": "", "NATS_SOURCE": "", "NATS_PORT": "4222", "NATS_USER": "", "NATS_PASSWORD": "", "INFLUX_HOST": "", "INFLUX_PORT": "8086", "INFLUX_DB_NAME": "tsdata", "INFLUX_USERNAME": "", "INFLUX_PASSWORD": "" } } } } ``` ### Option B: Per-project Create `.vscode/mcp.json` at the workspace root with the same JSON body. ## 3. Verify Open the Copilot Chat panel and check the tools menu. The Litmus tools should appear. If they don't: - Reload the VS Code window after editing `mcp.json`. - Confirm `curl http://:8000/health` returns `{"status":"ok"}` from your workstation. ## Reference - [VS Code: MCP servers](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) - [Headers Reference](#) [title] Cursor [path] Clients/ # Cursor IDE Configure [Cursor IDE](https://www.cursor.com/) to use the Litmus MCP server over SSE. ## 1. Run the server ```bash docker run -d --name litmus-mcp-server \ -p 8000:8000 \ ghcr.io/litmusautomation/litmus-mcp-server:latest ``` ## 2. Edit `mcp.json` - **User-wide:** `~/.cursor/mcp.json` - **Per-project:** `.cursor/mcp.json` in the repository root ```json { "mcpServers": { "litmus-mcp-server": { "url": "http://:8000/sse", "headers": { "EDGE_URL": "https://", "EDGE_API_CLIENT_ID": "", "EDGE_API_CLIENT_SECRET": "", "NATS_SOURCE": "", "NATS_PORT": "4222", "NATS_USER": "", "NATS_PASSWORD": "", "INFLUX_HOST": "", "INFLUX_PORT": "8086", "INFLUX_DB_NAME": "tsdata", "INFLUX_USERNAME": "", "INFLUX_PASSWORD": "" } } } } ``` Replace `` with where the Docker container is reachable (`localhost` if you're running both on the same machine). ## 3. Verify Open Cursor's MCP settings panel. The `litmus-mcp-server` entry should be listed with its tools enumerated. If you see a connection error: - Confirm Cursor's host can reach `http://:8000/sse`. - Check the container is up: `docker ps`. ## Reference - [Cursor: Model Context Protocol](https://docs.cursor.com/context/model-context-protocol) - [Headers Reference](#) [title] Claude Code [path] Clients/ Configure the [Claude Code CLI](https://docs.claude.com/en/docs/claude-code) to use the Litmus MCP server over SSE. ## 1. Run the server ```bash docker run -d --name litmus-mcp-server \ -p 8000:8000 \ ghcr.io/litmusautomation/litmus-mcp-server:latest ``` ## 2. Create or edit `~/.claude/mcp.json` Run Claude Code from a directory that has access to a config file at `~/.claude/mcp.json`: ```json { "mcpServers": { "litmus-mcp-server": { "type": "sse", "url": "http://localhost:8000/sse", "headers": { "EDGE_URL": "${EDGE_URL}", "EDGE_API_CLIENT_ID": "${EDGE_API_CLIENT_ID}", "EDGE_API_CLIENT_SECRET": "${EDGE_API_CLIENT_SECRET}", "NATS_SOURCE": "${NATS_SOURCE}", "NATS_PORT": "${NATS_PORT:-4222}", "NATS_USER": "${NATS_USER}", "NATS_PASSWORD": "${NATS_PASSWORD}", "INFLUX_HOST": "${INFLUX_HOST}", "INFLUX_PORT": "${INFLUX_PORT:-8086}", "INFLUX_DB_NAME": "${INFLUX_DB_NAME:-tsdata}", "INFLUX_USERNAME": "${INFLUX_USERNAME}", "INFLUX_PASSWORD": "${INFLUX_PASSWORD}" } } } } ``` The `${VAR}` syntax reads from your shell environment, so you can keep secrets out of the config file by exporting them before launching Claude Code. ## 3. Verify Inside Claude Code, ask the agent to list available tools. You should see the full Litmus tool set (DeviceHub, NATS, InfluxDB, Digital Twins, LEM, etc.). If you don't, check: - `docker logs litmus-mcp-server` for SSE connection attempts. - `curl http://localhost:8000/health` returns `{"status":"ok"}`. - The headers in `mcp.json` resolve to non-empty values (`echo "$EDGE_URL"`). ## Reference - [Anthropic: Model Context Protocol in Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/mcp) - [Headers Reference](#) [title] Windsurf [path] Clients/ Configure [Windsurf](https://codeium.com/windsurf) to use the Litmus MCP server over SSE. ## 1. Run the server ```bash docker run -d --name litmus-mcp-server \ -p 8000:8000 \ ghcr.io/litmusautomation/litmus-mcp-server:latest ``` ## 2. Edit `~/.codeium/windsurf/mcp_config.json` ```json { "mcpServers": { "litmus-mcp-server": { "url": "http://:8000/sse", "headers": { "EDGE_URL": "https://", "EDGE_API_CLIENT_ID": "", "EDGE_API_CLIENT_SECRET": "", "NATS_SOURCE": "", "NATS_PORT": "4222", "NATS_USER": "", "NATS_PASSWORD": "", "INFLUX_HOST": "", "INFLUX_PORT": "8086", "INFLUX_DB_NAME": "tsdata", "INFLUX_USERNAME": "", "INFLUX_PASSWORD": "" } } } } ``` ## 3. Verify Restart Windsurf so the new MCP server is picked up. The Litmus tools should be available in the agent's tool list. ## Reference - [Windsurf: MCP docs](https://docs.windsurf.com/windsurf/mcp) - [Headers Reference](#) [title] Headers Reference [path] Configuration/ # Headers Reference The Litmus MCP server is stateless. Every tool call reads its credentials from the request headers (SSE mode) or environment variables (STDIO mode). This page documents every header the server understands. ## Litmus Edge (REST / SDK) Required for almost every tool except a few system-only ones. | Header | Required | Description | | ------------------------ | -------- | ----------------------------------------- | | `EDGE_URL` | yes | Litmus Edge base URL. Include `https://`. | | `EDGE_API_CLIENT_ID` | yes | OAuth2 client ID issued by Litmus Edge. | | `EDGE_API_CLIENT_SECRET` | yes | OAuth2 client secret. | Generate the client credentials under **Litmus Edge -> System -> Access Control**. ## NATS (live values) Used by `get_current_value_from_topic` and `get_multiple_values_from_topic`. | Header | Required | Default | Description | | --------------- | -------- | ------- | ------------------------------------------------------------------ | | `NATS_SOURCE` | yes | | Litmus Edge IP, **no** scheme prefix. | | `NATS_PORT` | no | `4222` | NATS broker port. | | `NATS_USER` | yes | | Access token username from **System -> Access Control -> Tokens**. | | `NATS_PASSWORD` | yes | | Access token value. | | `NATS_TLS` | no | `true` | Set to `false` to disable TLS. | ## InfluxDB (time series) Used by every `**`-marked InfluxDB tool (`get_historical_data_from_influxdb`, `list_influxdb_measurements`, `get_device_historical_data`, `query_tag_data`, `get_tag_statistics`, `get_device_data_for_inference`, `get_device_connection_status`). | Header | Required | Default | Description | | ----------------- | -------- | -------- | ------------------------------------- | | `INFLUX_HOST` | yes | | Litmus Edge IP, **no** scheme prefix. | | `INFLUX_PORT` | no | `8086` | InfluxDB port. | | `INFLUX_DB_NAME` | no | `tsdata` | Database name. | | `INFLUX_USERNAME` | yes | | DataHub user. | | `INFLUX_PASSWORD` | yes | | DataHub password. | Allow port `8086/TCP` in **Litmus Edge -> System -> Network -> Firewall**. ## Litmus Edge Manager (LEM) Used by every `lem_*` tool. LEM tools talk to a cloud Edge Manager tenant rather than an edge. | Header | Required | Default | Description | | ------------------------- | -------- | ------------------------------ | ------------------------------------------------------------------------ | | `EDGE_MANAGER_URL` | yes | | LEM base URL. Include `https://`. | | `EDGE_API_TOKEN` | yes | | API token issued by LEM. | | `EDGE_MANAGER_PROJECT_ID` | no | | Default project id, used when a tool's `project_id` argument is omitted. | | `EDGE_MANAGER_ADMIN_URL` | no | `:8446` | Admin URL. | | `VALIDATE_CERTIFICATE` | no | `false` | `true` to verify TLS certs on the LEM bridge. | The `lem_bridge_*` tools additionally tunnel through LEM to a specific edge and require both `project_id` and `device_id` as call arguments. They do **not** switch the active edge instance. ## STDIO mode When the server runs in STDIO mode (`ENABLE_STDIO=true`), the same names are read from the process environment instead of HTTP headers. Pass them through your MCP client's `env` block. See [Claude Desktop (STDIO)](#). ## Header configuration guide - `EDGE_URL`: include `https://`. - `EDGE_API_CLIENT_ID` / `EDGE_API_CLIENT_SECRET`: OAuth2 credentials from Litmus Edge. - `NATS_SOURCE`: IP only, no `http`/`https`. - `NATS_USER` / `NATS_PASSWORD`: token credentials from **System -> Access Control -> Tokens**. - `INFLUX_HOST`: IP only, no `http`/`https`. - `INFLUX_USERNAME` / `INFLUX_PASSWORD`: DataHub user credentials. [title] LLM Providers [path] Configuration/ # LLM Providers The Web UI works with three LLM providers. The MCP server itself is provider-neutral; the choice only matters when you use the bundled chat interface. ## Supported providers | Provider | API key env var | Default model | | ---------------- | ------------------- | ------------------------ | | Anthropic Claude | `ANTHROPIC_API_KEY` | `claude-sonnet-4-6` | | OpenAI | `OPENAI_API_KEY` | `gpt-4.1` | | Google Gemini | `GEMINI_API_KEY` | latest Gemini chat model | Provide one or more keys at container startup, or enter them from the Web UI's setup screen. ```bash docker run -d --name litmus-mcp-server \ -p 8000:8000 -p 9000:9000 \ -e ANTHROPIC_API_KEY= \ -e OPENAI_API_KEY= \ -e GEMINI_API_KEY= \ ghcr.io/litmusautomation/litmus-mcp-server:latest ``` ## Switching provider and model `/update-env` has a two-panel selector: - **Left:** provider pills, one per configured key. - **Right:** scrollable list of models, fetched live from the provider's API (`client.models.list` for Anthropic, `oai.models.list` filtered to chat-capable models for OpenAI). Selecting a model writes both: - `PREFERRED_MODEL` - the provider identifier (`anthropic`, `openai`, `gemini`) - `PREFERRED_MODEL_ID` - the specific model id (e.g., `claude-sonnet-4-6`) `client_utils._get_model_id(provider)` reads `PREFERRED_MODEL_ID` from env, falling back to the provider's default. ## How the chat uses the provider The Web UI's `/chat` endpoint streams from the selected provider, parsing tool-use events back into MCP `session.call_tool(...)` calls. The user sees: - Streamed prose, rendered as markdown. - A tool-call badge each time the model asks the MCP server to do something. - A stop button to cancel mid-stream. ## API endpoints (provider-related) | Endpoint | Method | Purpose | | ------------------------ | ------ | ------------------------------------------------------------- | | `/api/models?provider=X` | GET | Fetch the live model list for a provider. | | `/setup-key` | POST | Save one or more API keys (AJAX). Returns `{"saved": [...]}`. | | `/setup` | POST | Same as `/setup-key`, but used as the `