Skip to content

Get-Licconfigusagesamples

Returns current configuration for sample collection on license usages.

Syntax

Get-LicConfigUsageSamples [-AdminAddress] <String> [-CertHash <String>] [<CommonParameters>]

Detailed Description

Returns the configuration stored on License Server for a sample collection about licenses usages.

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)
CertHash Specifies the hash of the License Server certificate needing verification. false false

Input Type

System.String

Return Values

Citrix.Licensing.Admin.Sdk.Wslconfigusagesample

Notes

If the command fails, one of the following errors is returned.
Error Codes
-----------
LicensingAdminStatus.CommunicationError
There was a problem communicating with the License Server.
LicensingAdminStatus.InvalidCertificate
Certificate is not verified or it is self-signed. Get the Certificate and store the Hash in Ccs.
LicensingAdminStatus.CertificateVerificationFailed
Certificate is not verified or it is self-signed. Get the Certificate and store the Hash in Ccs.
LicensingAdminStatus.UnknownError
An unexpected error occurred. For more details, see the Windows event logs on the controller.

Examples

Example 1

PS C:\>$cert = Get-LicCertificate -AdminAddress https://licserver.mydomain.net:8083

PS C:\> Get-LicConfigUsageSamples -AdminAddress https://licserver.mydomain.net:8083 -CertHash $cert.CertHash
```Returns the configuration for sample usage collection on the License Server.&lt;br&gt;Output:&lt;br&gt;Enabled            : True&lt;br&gt;PollingInterval    : 15&lt;br&gt;RetentionPeriod    : 180&lt;br&gt;EarliestSampleTime : 1/30/2015 7:51:20 AM&lt;br&gt;LatestSampleTime   : 2/5/2015 9:08:08 AM&lt;br&gt;Note:&lt;br&gt;PollingInterval   (in minutes)&lt;br&gt;RetentionPeriod (in days)
### Example 2

PS C:>$cert = Get-LicCertificate -AdminAddress https://licserver.mydomain.net:8083

PS C:> Get-LicConfigUsageSamples -AdminAddress https://licserver.mydomain.net:8083 -CertHash $cert.CertHash ```Returns the configuration for sample usage collection on the License Server.<br>Output:<br>Enabled : False<br>PollingInterval :<br>RetentionPeriod :<br>EarliestSampleTime : 1/30/2015 7:51:20 AM<br>LatestSampleTime : 2/5/2015 9:08:08 AM<br>Note:<br>PollingInterval (in minutes)<br>RetentionPeriod (in days)

Was this article helpful?