Remove-XenVDIProperty

Last published : Nov 12, 2026
Removes values from fields of a VDI object.
Related information
VDI cmdlets

Syntax

Remove-XenVDIProperty [-VDI] <VDI> [-PassThru] [-OtherConfig <string>]
    [-XenstoreData <string>] [-SmConfig <string>] [-Tags <string>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenVDIProperty [-Ref] <XenRef[VDI]> [-PassThru] [-OtherConfig <string>]
    [-XenstoreData <string>] [-SmConfig <string>] [-Tags <string>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenVDIProperty [-Uuid] <guid> [-PassThru] [-OtherConfig <string>]
    [-XenstoreData <string>] [-SmConfig <string>] [-Tags <string>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenVDIProperty [-Name] <string> [-PassThru] [-OtherConfig <string>]
    [-XenstoreData <string>] [-SmConfig <string>] [-Tags <string>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Removes values from the collection-valued fields of a VDI. Each optional parameter listed below corresponds to a field that can be removed from.

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

-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 VDI to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-OtherConfig

Remove the given key and its corresponding value from the other\_config field of the given VDI. If the key is not in that Map, then do nothing.
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

-Ref

The VDI object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[VDI]
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

-SmConfig

Remove the given key and its corresponding value from the sm\_config field of the given VDI. If the key is not in that Map, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Tags

Remove the given value from the tags field of the given VDI. If the value is not in that Set, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Uuid

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

-VDI

The VDI object to operate on.
Attribute Value
Type VDI
Required True
Position 0
Accepts pipeline input True (ByValue)

-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

-XenstoreData

Remove the given key and its corresponding value from the xenstore\_data field of the given VDI. If the key is not in that Map, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

Inputs

  • VDI
  • XenRef[VDI]
  • guid
  • string

Outputs

  • VDI

Examples

Example 1: Remove from the OtherConfig field

PS> Remove-XenVDIProperty -OtherConfig "value" -Name "Demo VDI"
Removes a value from the OtherConfig field of a VDI.

Example 2: Remove from the XenstoreData field

PS> Remove-XenVDIProperty -XenstoreData "value" -Name "Demo VDI"
Removes a value from the XenstoreData field of a VDI.

Example 3: Remove from the SmConfig field

PS> Remove-XenVDIProperty -SmConfig "value" -Name "Demo VDI"
Removes a value from the SmConfig field of a VDI.
  • VDI cmdlets
  • Class: VDI
  • Using the XenServer PowerShell module