Set-ZrLicense
Activates — or, with -Deactivate, releases — a Zaris license or trial-extension key across every manager machine in the workspace.
Syntax
Set-ZrLicense
[-Key] <string>
[-Deactivate]
[-Managers <string[]>] [-Port <int>] [-Token <string>] [-TimeoutSec <int>] [-FailFast]
[-WhatIf] [-Confirm]
Description
Because licensing is per machine, Set-ZrLicense applies the key to every manager in the workspace — each binds its own per-machine seat — so the key must cover all managers. Use it for an Enterprise license key or a Trial-tier extension key; an extension extends the current trial, it never restarts a consumed one.
For each resolved manager the cmdlet activates the key (or releases it with -Deactivate) and prints the resulting stage and status, the same columns as Get-ZrLicenseStatus. It requires a connected manager or an explicit -Managers list, and supports -WhatIf/-Confirm. With -FailFast it stops at the first manager that errors.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
-Key | string | Yes | The license or extension key to activate (or release with -Deactivate). Position 0. |
-Deactivate | switch | No | Release this key's seat on each manager instead of activating it. |
-Managers | string[] | No | Management Service endpoints (host, host:port, or URL) to target. When omitted, the active workspace's managers are used. |
-Port | int | No | Management Service port for bare-host managers. Default 7801. |
-Token | string | No | Admin bearer token for authenticated control-plane calls. |
-TimeoutSec | int | No | Per-request timeout in seconds. Default 30. |
-FailFast | switch | No | Stop at the first manager that returns an error. |
Supports -WhatIf and -Confirm.
Examples
Activate an Enterprise license key on every manager in the workspace.
Set-ZrLicense -Key "LIC-XXXX..."
Release a key's seat across the workspace.
Set-ZrLicense -Key "LIC-XXXX..." -Deactivate