Skip to content

New-Licallocation

Gets License Inventory Data from the License Server

Syntax

New-LicAllocation [-AdminAddress] <String> -EntitlementId <String> -Count <Int32> -SessionId <String> [-CertHash <String>] [-Credentials <PSCredential>] [<CommonParameters>]

Detailed Description

Returns detailed information about licenses in the inventory of the server pointed to by the snapin

Parameters

Name Description Required? Pipeline Input Default Value
AdminAddress Specifies the Web Services for Licensing address of the License Server that the PowerShell Snap-in will connect to. Retrieve this address with Get-LicLocation. true true (ByValue)
EntitlementId Entitlement Id from which to allocate licenses. true false
Count Number of licenses to allocate. true false false
SessionId SessionId from Get-LicEntitlements. true false false
CertHash Specifies the hash of the License Server certificate needing verification. false false
Credentials Specifies the username/password to be authenticated with the License Server. false false

Input Type

Return Values

Notes

If the command fails, one of the following errors is returned.
Error Codes
-----------
LicensingAdminStatus.UserNotAuthorized
The currently authenticated user is not authorized to perform this operation.
LicensingAdminStatus.CommunicationError
There was a problem communicating with the License Server.
LicensingAdminStatus.NoWriteAccess
No write permission for writing license file.
LicensingAdminStatus.LicenseWriteFailed
Have write permission but license file could not be written.
LicensingAdminStatus.InvalidEntitlementId
The Entitlement ID specified is invalid.
LicensingAdminStatus.InvalidSession
The Session ID specified is invalid.
LicensingAdminStatus.SessionExpired
The Session ID specified has expired.
LicensingAdminStatus.InvalidCount
The license count specified is invalid.
LicensingAdminStatus.UnknownError
An unexpected error occurred. For more details, see the Windows event logs on the controller.

Examples

Example 1

C:\PS>New-LicAllocation -AdminAddress https://licserver.mydomain.net:8083 -EntitlementId key002 -Count 10 -SessionId 551FL1YZ2KVPAQDZYXN1Allocates and downloads 10 licenses from citrix.com.

Was this article helpful?