Add-XenRateLimit

Last published : Nov 12, 2026
Adds to fields of a RateLimit object.
Related information
RateLimit cmdlets

Syntax

Add-XenRateLimit [-RateLimit] <Rate_limit> [-PassThru] [-Caller <XenRef[Caller]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenRateLimit [-Ref] <XenRef[Rate_limit]> [-PassThru] [-Caller <XenRef[Caller]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenRateLimit [-Uuid] <guid> [-PassThru] [-Caller <XenRef[Caller]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenRateLimit [-Name] <string> [-PassThru] [-Caller <XenRef[Caller]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Adds values to the collection-valued fields of a RateLimit. Each optional parameter listed below corresponds to a field that can be added to.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress. Available only for those fields whose underlying operation supports asynchronous invocation.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-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

-Caller

Attach the given caller to this rate limiter. Replaces any rate limiter previously attached to the caller.
Attribute Value
Type XenRef[Caller]
Required False
Position Named
Accepts pipeline input False

-Confirm

Prompts for confirmation before running the cmdlet.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases cf

-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

-PassThru

If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
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

-Uuid

The UUID of the RateLimit to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases wi

Inputs

  • Rate_limit
  • XenRef[Rate_limit]
  • guid
  • string

Outputs

  • Rate_limit
  • Task
  • void

Examples

Example 1: Add a caller

PS> $caller = Get-XenCaller | Select-Object -First 1
PS> Add-XenRateLimit -Caller $caller -Name "Demo RateLimit"
Attach the given caller to this rate limiter. Replaces any rate limiter previously attached to the caller.

Example 2: Add a caller piped from the getter

PS> $caller = Get-XenCaller | Select-Object -First 1
PS> Get-XenRateLimit -Name "Demo RateLimit" | Add-XenRateLimit -Caller $caller
Attach the given caller to this rate limiter. Replaces any rate limiter previously attached to the caller. The object is piped in, which is the usual way once you already have it.

Example 3: Add a caller by uuid

PS> $caller = Get-XenCaller | Select-Object -First 1
PS> Add-XenRateLimit -Caller $caller -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Attach the given caller to this rate limiter. Replaces any rate limiter previously attached to the caller. -Uuid is the way to be sure of exactly one object.