Get-XenRateLimitProperty

Last published : Nov 12, 2026
Gets a property of a RateLimit object.
Related information
RateLimit cmdlets

Syntax

Get-XenRateLimitProperty [-RateLimit] <Rate_limit>
    -XenProperty {Uuid | NameLabel | NameDescription | Callers | BurstSize | FillRate}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenRateLimitProperty [-Ref] <XenRef[Rate_limit]>
    -XenProperty {Uuid | NameLabel | NameDescription | Callers | BurstSize | FillRate}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a RateLimit object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given Rate\_limit.
NameLabel: Get the name/label field of the given Rate\_limit.
NameDescription: Get the name/description field of the given Rate\_limit.
Callers: Get the callers field of the given Rate\_limit.
BurstSize: Get the burst\_size field of the given Rate\_limit.
FillRate: Get the fill\_rate field of the given Rate\_limit.

Parameters

-BestEffort

If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-RateLimit

The RateLimit object to operate on.
Attribute Value
Type Rate_limit
Required True
Position 0
Accepts pipeline input True (ByValue)

-Ref

The RateLimit object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Rate_limit]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SessionOpaqueRef

The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-XenProperty

Selects which property to use.
Attribute Value
Type XenRateLimitProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, Callers, BurstSize, FillRate

Inputs

  • Rate_limit
  • XenRef[Rate_limit]

Outputs

  • System.Object

Examples

Example 1: Get the Callers property

PS> Get-XenRateLimit -Name "Demo RateLimit" | Get-XenRateLimitProperty -XenProperty Callers
Gets the Callers property of a RateLimit.

Example 2: Get the BurstSize property

PS> Get-XenRateLimit -Name "Demo RateLimit" | Get-XenRateLimitProperty -XenProperty BurstSize
Gets the BurstSize property of a RateLimit.

Example 3: Get the FillRate property

PS> Get-XenRateLimit -Name "Demo RateLimit" | Get-XenRateLimitProperty -XenProperty FillRate
Gets the FillRate property of a RateLimit.