Get-XenRateLimit
Gets the RateLimit objects in the pool.
Syntax
Get-XenRateLimit [[-Ref] <XenRef[Rate_limit]>] [-BestEffort] [-SessionOpaqueRef <string>]
[<CommonParameters>]
Get-XenRateLimit [-Uuid] <guid> [-BestEffort] [-SessionOpaqueRef <string>]
[<CommonParameters>]
Get-XenRateLimit [-Name] <string> [-BestEffort] [-SessionOpaqueRef <string>]
[<CommonParameters>]
Description
Retrieves the RateLimit objects in the pool. With no parameters the cmdlet returns the whole collection; use -Name, -Uuid or -Ref to select one.
RateLimit: A rate limiter associated with one or more callers.
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 |
-Name
The name of the RateLimit to operate on.
| Attribute | Value |
|---|---|
| Type | string |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | name_label |
-Ref
The RateLimit object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[Rate_limit] |
| Required | False |
| 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 |
-Uuid
The UUID of the RateLimit to operate on.
| Attribute | Value |
|---|---|
| Type | guid |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
Inputs
-
XenRef[Rate_limit] -
guid -
string
Outputs
-
Rate_limit[]
Examples
Example 1: List every RateLimit
PS> Get-XenRateLimit
Retrieves every RateLimit object in the pool. With no parameters the cmdlet fetches the whole collection.
Example 2: Retrieve one RateLimit by name
PS> Get-XenRateLimit -Name "Demo RateLimit"
Retrieves a single RateLimit. -Name matches on name\_label, which is not unique, so every match is operated on.
Example 3: Retrieve one RateLimit by uuid
PS> Get-XenRateLimit -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Retrieves a single RateLimit. -Uuid is the way to be sure of exactly one object.
Related links
-
Class: RateLimit
-
Using the XenServer PowerShell module