New-XenRateLimit

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

Syntax

New-XenRateLimit -HashTable <hashtable> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenRateLimit -Record <Rate_limit> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenRateLimit [-PassThru] [-NameLabel <string>] [-NameDescription <string>]
    [-BurstSize <double>] [-FillRate <double>] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]

Description

Creates a new 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

-BurstSize

Maximum tokens that the bucket can hold
Attribute Value
Type double
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

-FillRate

Tokens added to the bucket per second
Attribute Value
Type double
Required False
Position Named
Accepts pipeline input False

-HashTable

A hashtable of field names to values, from which to create the RateLimit.
Attribute Value
Type hashtable
Required True
Position Named
Accepts pipeline input False

-NameDescription

a notes field containing human-readable description
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-NameLabel

a human-readable name
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-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

-Record

An existing RateLimit record whose fields are used to create the new object.
Attribute Value
Type Rate_limit
Required True
Position Named
Accepts pipeline input False

-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

-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

  • None

Outputs

  • Rate_limit
  • Task
  • void

Examples

Example 1: Create a RateLimit from a table of fields

PS> New-XenRateLimit -HashTable @{ name_label = "Demo RateLimit" } -PassThru
The keys are the API's field names, so this form reads the same for every class whatever fields it happens to have. -PassThru returns the new RateLimit.

Example 2: Create a RateLimit from parameters

PS> New-XenRateLimit -NameLabel "new value" -PassThru
The same thing with one parameter per field, which is the form that tab-completes. Get-Help New-XenRateLimit -Full lists them all.

Example 3: Create a RateLimit from an existing one

PS> $record = Get-XenRateLimit | Select-Object -First 1
PS> New-XenRateLimit -Record $record -PassThru
-Record takes a whole RateLimit record, so an existing object can be used as the template for a new one.