This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-BrokerLease
Gets stored leases.
Syntax
Get-BrokerLease [-Uid] <Int64> [-Property <String[]>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
Get-BrokerLease [[-Key] <String>] [-Expiration <DateTime>] [-LastModified <DateTime>] [-LeaseType <BrokerLeaseType>] [-OwnerSAMName <String>] [-OwnerSID <String>] [-OwnerUPN <String>] [-ZoneUid <Guid>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-Property <String[]>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
Gets leases filtered by specific Uid or Owner information.
Brokerlease Object
The BrokerLease object represents a single instance of a lease. It contains the following properties:
-
Expiration (System.DateTime) The expiration time of the lease.
-
Key (System.String) The SHA1 representation of the lease key.
-
LastModified (System.DateTime) The modification time of the lease.
-
LeaseType (Citrix.Broker.Admin.SDK.BrokerLeaseType) The type of lease.
-
OwnerSAMName (System.String) The SAM name of the user associated with the lease.
-
OwnerSID (System.String) The SID of the user associated with the lease.
-
OwnerUPN (System.String) The UPN of the user associated with the lease.
-
Uid (System.Int64) The UID of the lease itself.
-
Value (System.String) The serialized lease data in XML.
-
ZoneName (System.String) Name of the Zone this resource belongs to.
-
ZoneUid (System.Guid?) Uid of the Zone this resource belongs to.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Uid | Gets only the lease specified by unique identifier. | true | false | |
| Key | Gets only the leases matching the specified lease key pattern. | false | false | |
| Expiration | Gets only the leases matching the specified expiration date and time. | false | false | |
| LastModified | Gets only the leases matching the specified modified date and time. | false | false | |
| LeaseType | Gets only leases of a specific type. Possible values Enumeration, Launch. | false | false | |
| OwnerSAMName | Gets only the leases associated with the specified Domain\User. | false | false | |
| OwnerSID | Gets only the leases associated with the specified user SID. | false | false | |
| OwnerUPN | Gets only the leases associated with the specified user UPN. | false | false | |
| ZoneUid | Gets only the leases of resources beloning to Zone with specified Uid. | false | false | |
| ReturnTotalRecordCount | When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details. | false | false | False |
| MaxRecordCount | Specifies the maximum number of records to return. | false | false | 250 |
| Skip | Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. | false | false | 0 |
| SortBy | Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present. | false | false | The default sort order is by name or unique identifier. |
| Filter | Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details. | false | false | |
| FilterScope | Gets only results allowed by the specified scope id. | false | false | |
| Property | Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server. | false | false | |
| AdminClientIP | Internal use only. | false | false | |
| AdminAddress | Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value will become the default. |
| BearerToken | Specifies the bearer token assigned to the calling user | false | false | |
| TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | |
| TraceState | Specifies the trace state assigned for internal diagnostic tracing use | false | false | |
| VirtualSiteId | Specifies the virtual site the PowerShell snap-in will connect to. | false | false |
Input Type
None
Input cannot be piped to this cmdlet.
Return Values
Citrix.Broker.Admin.Sdk.Lease
Returns an Lease object for each enumerated lease.
Examples
Example 1
C:\PS> $lease = Get-BrokerLease -Uid 1
<!--NeedCopy-->
Description
Gets the lease with internal Uid 1.
Example 2
C:\PS> $leases = Get-BrokerLease -OwnerSAMName Domain\User
<!--NeedCopy-->
Description
Gets the leases associated with the specified user.
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.