Citrix Daas SDK

Get-BrokerLease

August 9, 2024

Contributed by:

C C

Gets stored leases.

Syntax

Get-BrokerLease
   [[-Key] <String>]
   [-Expiration <DateTime>]
   [-LastModified <DateTime>]
   [-LeaseType <BrokerLeaseType>]
   [-OwnerSAMName <String>]
   [-OwnerSID <String>]
   [-OwnerUPN <String>]
   [-ZoneUid <Guid>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Get-BrokerLease
   [-Uid] <Int64>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

Gets the lease with internal Uid 1.

$lease = Get-BrokerLease -Uid 1
<!--NeedCopy-->

EXAMPLE 2

Gets the leases associated with the specified user.

$leases = Get-BrokerLease -OwnerSAMName Domain\User
<!--NeedCopy-->

Parameters

-Uid

Gets only the lease specified by unique identifier.

Type:	Int64
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Key

Gets only the leases matching the specified lease key pattern.

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Expiration

Gets only the leases matching the specified expiration date and time.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LastModified

Gets only the leases matching the specified modified date and time.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LeaseType

Gets only leases of a specific type. Possible values Enumeration, Launch.

Type:	BrokerLeaseType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OwnerSAMName

Gets only the leases associated with the specified Domain\User.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-OwnerSID

Gets only the leases associated with the specified user SID.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-OwnerUPN

Gets only the leases associated with the specified user UPN.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-ZoneUid

Gets only the leases of resources beloning to Zone with specified Uid.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxRecordCount

Specifies the maximum number of records to return.

Type:	Int32
Position:	Named
Default value:	250
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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.

Type:	String
Position:	Named
Default value:	The default sort order is by name or unique identifier.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Filter

Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilterScope

Gets only results allowed by the specified scope id.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Input cannot be piped to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.Lease

Returns an Lease object for each enumerated lease.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-BrokerLease

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

Get-BrokerLease

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-Uid

-Key

-Expiration

-LastModified

-LeaseType

-OwnerSAMName

-OwnerSID

-OwnerUPN

-ZoneUid

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

-Property

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Broker.Admin.SDK.Lease

Related Links

In this article