Get-CatSession
Returns the current CAT session — who is signed in, the effective plan and its limits, the resolved license key, and the open project.
Synopsis
Get-CatSession
Parameters
None (common parameters only).
What it does
Writes the session object the module created with the last Open-CatProject / Invoke-CatProject (or New-CatProject / Get-CatProjectTemplate). It answers the questions Get-CatInstance cannot: as whom am I signed in, which plan applies, what does it limit, is the authorisation from the cache?
Output
One CatSession object; the useful properties:
| Property | Meaning |
|---|---|
SignedInUser |
Email, UserName, Plan, FromCache (working offline), ExpiresAt (end of the offline grace), AuthMethod; empty when a license key unlocked the plan. |
EffectivePlan |
The plan in force: Starter, Professional, Team, Enterprise (or legacy Business). |
CurrentLimitations |
What the plan allows: AllowedTools, InteractiveUsageOnly, OutputToExcelOnly, MaximumNumberOfTestsPerProject, MaximumNumberOfTestsPerRun, MaximumNumberOfThreads, NumberOfDataSourcesPerProject, NumberOfTechnologies, ExpiryDate. |
ResolvedLicenseKey |
The key CAT resolved: Status (Valid, Expired, Future, NotSet, …), Plan, ValidFrom, ValidTo. |
Project |
The open project (the same object as Get-CatProject). |
LatestRunSummary |
The result of the last run (the same object as Get-CatTestResultSummary). |
InvocationContext |
AutomationPlatform, Scheduler, ToolVersion, CoreVersion, operating system. |
SessionID |
Identifier of this session. |
Errors
There is no CAT session active. It will be created once you use Open-CatProject. when no session exists yet.
Examples
Open-CatProject
$s = Get-CatSession
$s.EffectivePlan
$s.SignedInUser | Select-Object Email, Plan, FromCache, ExpiresAt
$s.CurrentLimitations.InteractiveUsageOnly
Related
- Introduction — session model, logging, errors, sign-in.
Get-CatInstance— the installation (works without a session).