Remove-XenRateLimit

Last published : Nov 12, 2026
Deletes a RateLimit object.
Related information
RateLimit cmdlets

Syntax

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

Description

Deletes the specified RateLimit object.
RateLimit: A rate limiter associated with one or more callers.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
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

-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

  • Task
  • void

Examples

Example 1: Delete a RateLimit piped from the getter

PS> Get-XenRateLimit -Name "Demo RateLimit" | Remove-XenRateLimit
Deletes a RateLimit. The object is piped in, which is the usual way once you already have it.

Example 2: Delete a RateLimit by name

PS> Remove-XenRateLimit -Name "Demo RateLimit"
Deletes a RateLimit. -Name matches on name\_label, which is not unique, so every match is operated on.

Example 3: See what would be deleted

PS> Get-XenRateLimit -Name "Demo RateLimit" | Remove-XenRateLimit -WhatIf
Reports the RateLimit that would be deleted without deleting anything. Every cmdlet that changes the server takes -WhatIf and -Confirm.