Skip to content

07-LicensingGuide.md

Latest commit

 

History

History
214 lines (164 loc) · 9.46 KB

07-LicensingGuide.md

File metadata and controls

214 lines (164 loc) · 9.46 KB
Raw
title Licensing
nav_order 7
permalink /licensing/

Licensing Guide

UiPath licensing is exposed by UiPathOrch through two families of cmdlets that work at two different layers. Understanding which layer answers which question is the key to using them.

Layer Cmdlet prefix Scope Web equivalent
Organization *-Pm*License* The whole Automation Cloud organization Admin → Licenses (account/org screens)
Tenant *-OrchLicense* A single tenant (the drive you are on) Tenant → License
  • Organization (Pm*) answers "what did we buy, and how is it parcelled out?" — the contract, the named-user bundles, the per-tenant allocation, and who/which group holds which bundle. These call the Platform Management / portal APIs, so they need an organization-level sign-in (see Getting Started); they return the same data regardless of which tenant drive you point -Path at.
  • Tenant (Orch*) answers "what is this tenant allowed, and what is it using right now?" — the allowed-vs-used counts, the named-user assignments, the per-machine runtime slots, and the usage history.

Two license kinds run through everything:

  • User bundles (Named User) — a per-person seat such as ATTUNU (Attended – Named User) or RPADEVPRONU (Automation Developer – Named User). Bought at the org level, assigned to users/groups (Pm*), consumed when those users sign in.
  • Runtime licenses — per-machine execution slots (Unattended, NonProduction, Testing). Allocated from the org pool to each tenant (Get-PmLicenseAllocation), then consumed machine-by-machine inside the tenant (Get-OrchLicenseRuntime).

Organization layer — Pm* cmdlets

Read

Cmdlet Answers Key output fields
Get-PmLicenseContract The account-level contract — what was purchased BundleCode, LicenseCode, LicenseStatus, SubscriptionPlan, StartDate/EndDate, GracePeriod, plus Products, Templates, Entitlements, MlKeys collections
Get-PmLicenseInventory The org inventory dashboard (Robots & Services summary) ProductAllocations, UserLicensingBundles, EntitlementUsages, AvailableServices, MlKeys
Get-PmLicense Named-User bundles and their seat counts code, name, allocated, total, inUse
Get-PmLicenseAllocation Per-tenant allocation of the org pool (Robots & Services tab) tenant, unattendedRobot, nonProductionRobot, testingRobot, dataServiceUnit, services, …
Get-PmUserLicense The licensed users and the bundles they hold email/name, lastInUse, userBundleLicenses, orphan
Get-PmGroupLicense The licensed groups and their bundles name, userBundleLicenses, useExternalLicense, orphan

Get-PmLicense accepts -Code to filter to one bundle and -HasCapacity to show only bundles with seats still free (allocated < total). Get-PmLicenseAllocation accepts -Tenant to focus on one tenant. Get-PmUserLicense/Get-PmGroupLicense support -ExportCsv / -CsvEncoding, and Get-PmGroupLicense adds -ExpandAllocation to expand each group's member allocations.

orphan = True marks a license still held by a user/group that no longer exists — the first thing to reclaim when freeing seats.

Write

Cmdlet Effect
Add-PmUserLicense -Email <user> -License <code> Assign one or more bundles to a user
Remove-PmUserLicense -Email <user> -License <code> Unassign bundles from a user
Add-PmGroupLicense -GroupName <g> -License <code> Assign a bundle to a group
Remove-PmGroupLicense -GroupName <g> -License <code> Unassign a bundle from a group
Remove-PmGroupLicenseAllocation -GroupName <g> -UserName <u> Drop one user's allocation under a group
Remove-PmLicensedUser -Email <user> Drop a user from the licensed-users set entirely
Remove-PmLicensedGroup -GroupName <g> Drop a group from the licensed set

Tenant layer — Orch* cmdlets

Cmdlet Answers Key output fields
Get-OrchLicense What the tenant is allowed vs using Usage (per-type Used/Allowed/Percent, shown by default), the raw Allowed / Used dicts, SubscriptionCode/Plan, ExpireDateLocal, GracePeriod, UserLicensingEnabled, IsExpired
Get-OrchLicenseNamedUser -RobotType <t> Named-user license assignments UserName, IsLicensed, MachinesCount, LastLoginDate
Get-OrchLicenseRuntime -RobotType <t> Per-machine runtime slots MachineName, Runtimes, RobotsCount, ExecutingCount, IsOnline, Enabled, MachineScope
Get-OrchLicenseStats -Last <period> Historical usage over time robotType, count, timestamp

RobotType is one of Unattended, NonProduction, Testing, Attended, Development, … (the same robot types shown on the tenant license screen). To turn a machine's runtime license on or off, use Enable-OrchLicenseRuntime / Disable-OrchLicenseRuntime -RobotType <t> -Key <machine>.

Dates are Unix epoch seconds. Get-OrchLicense returns ExpireDate / GracePeriodEndDate as integers — convert with [DateTimeOffset]::FromUnixTimeSeconds($lic.ExpireDate).LocalDateTime.

Common tasks

All examples are run from a tenant drive (e.g. PS Orch1:\>); pass -Path Orch1: from a C:\ prompt instead if you prefer not to cd first.

How many Named-User seats are left, per bundle?

PS Orch1:\> Get-PmLicense | Select-Object code, name, allocated, total,
    @{ Name = 'free'; Expression = { $_.total - $_.allocated } }
# or only the bundles that still have capacity:
PS Orch1:\> Get-PmLicense -HasCapacity

Who holds a particular bundle (e.g. Attended – Named User)?

PS Orch1:\> Get-PmUserLicense | Where-Object { $_.userBundleLicenses -contains 'ATTUNU' }

Reclaim orphaned licenses (held by users/groups that no longer exist):

PS Orch1:\> Get-PmUserLicense | Where-Object orphan | Select-Object id, lastInUse, userBundleLicenses
# then drop each from the licensed set:
PS Orch1:\> Get-PmUserLicense | Where-Object orphan | ForEach-Object { Remove-PmLicensedUser -Email $_.email }

How is the org pool split across tenants?

PS Orch1:\> Get-PmLicenseAllocation | Select-Object @{ N = 'Tenant'; E = { $_.tenant.name } },
    unattendedRobot, nonProductionRobot, testingRobot, dataServiceUnit

What is this tenant allowed vs using?

Get-OrchLicense prints a per-type usage summary by default (the same "Used of Allowed (%)" the license page shows). For scripting, each row is on the Usage property:

PS Orch1:\> Get-OrchLicense | Select-Object -ExpandProperty Usage
Type           Used Allowed Percent
----           ---- ------- -------
Unattended        3       5      60
TestAutomation    3       5      60
NonProduction     4       5      80

The raw Allowed / Used dictionaries remain available, and ExpireDateLocal / GracePeriodEndDateLocal expose the epoch dates as DateTime.

Which machines hold a runtime slot, and are they online?

PS Orch1:\> Get-OrchLicenseRuntime | Select-Object RobotType, MachineName, Runtimes, RobotsCount, IsOnline, Enabled

Activate / deactivate a machine's runtime license (the Active toggle):

PS Orch1:\> Disable-OrchLicenseRuntime NonProduction m2 -WhatIf   # preview
PS Orch1:\> Disable-OrchLicenseRuntime NonProduction m2           # Active -> off
PS Orch1:\> Enable-OrchLicenseRuntime  NonProduction m2           # Active -> on

Enable-OrchLicenseRuntime / Disable-OrchLicenseRuntime flip the same Enabled flag shown by Get-OrchLicenseRuntime (the Active toggle on the license page). The first argument is the RobotType, the second the machine Key; both accept wildcards and tab completion, and -WhatIf previews the change.

Usage trend over the last month:

PS Orch1:\> Get-OrchLicenseStats -Last Month

Assign / free a Named-User bundle:

PS Orch1:\> Add-PmUserLicense -Email ytsuda@gmail.com -License ATTUNU
PS Orch1:\> Remove-PmUserLicense -Email ytsuda@gmail.com -License ATTUNU

How the layers fit together

flowchart TB
  subgraph ORG["Organization layer · Pm* cmdlets (whole org)"]
    direction TB
    C["Get-PmLicenseContract<br/>what the org bought:<br/>subscription, products, ML keys"]
    B["Get-PmLicense<br/>Named-User bundle seats:<br/>total → allocated → inUse"]
    A["Get-PmLicenseAllocation<br/>org pool split per tenant:<br/>runtime robots, units, services"]
    UG["Get-PmUserLicense /<br/>Get-PmGroupLicense<br/>assigned to users / groups"]
    C --> B --> UG
    C --> A
  end
  subgraph TEN["Tenant layer · Orch* cmdlets (current drive)"]
    direction TB
    L["Get-OrchLicense<br/>Allowed vs Used per type"]
    N["Get-OrchLicenseNamedUser<br/>named-user assignments here"]
    R["Get-OrchLicenseRuntime<br/>per-machine runtime slots"]
    S["Get-OrchLicenseStats<br/>usage history over time"]
  end
  UG -->|consumed when users sign in| N
  A -->|runtime slots per tenant| R
  N --> L
  R --> L
  L -.-> S
Loading

See also