New-XenPBD

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

Syntax

New-XenPBD -HashTable <hashtable> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenPBD -Record <PBD> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [-Async] [<CommonParameters>]
New-XenPBD [-PassThru] [-XenHost <XenRef[Host]>] [-SR <XenRef[SR]>]
    [-DeviceConfig <hashtable>] [-OtherConfig <hashtable>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]

Description

Creates a new PBD object.
PBD: The physical block devices through which hosts access SRs.

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

-DeviceConfig

a config string to string map that is provided to the host's SR-backend-driver
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-HashTable

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

-OtherConfig

additional configuration
Attribute Value
Type hashtable
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 PBD record whose fields are used to create the new object.
Attribute Value
Type PBD
Required True
Position Named
Accepts pipeline input False

-SR

the storage repository that the pbd realises
Attribute Value
Type XenRef[SR]
Required False
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

-XenHost

physical machine on which the pbd is available
Attribute Value
Type XenRef[Host]
Required False
Position Named
Accepts pipeline input False

Inputs

  • None

Outputs

  • PBD
  • Task
  • void

Examples

Example 1: Create a PBD from a table of fields

PS> New-XenPBD -HashTable @{ name_label = "Demo PBD" } -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 PBD.

Example 2: Create a PBD from parameters

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

Example 3: Create a PBD from an existing one

PS> $record = Get-XenPBD | Select-Object -First 1
PS> New-XenPBD -Record $record -PassThru
-Record takes a whole PBD record, so an existing object can be used as the template for a new one.
  • PBD cmdlets
  • Class: PBD
  • Using the XenServer PowerShell module