Remove-XenSRProperty

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

Syntax

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

Description

Removes values from the collection-valued fields of an SR. 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 SR 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 SR. 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 SR object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[SR]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SR

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

-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 SR. 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 SR. 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 SR 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

  • SR
  • XenRef[SR]
  • guid
  • string

Outputs

  • SR

Examples

Example 1: Remove from the OtherConfig field

PS> Remove-XenSRProperty -OtherConfig "value" -Name "Demo SR"
Removes a value from the OtherConfig field of an SR.

Example 2: Remove from the Tags field

PS> Remove-XenSRProperty -Tags "value" -Name "Demo SR"
Removes a value from the Tags field of an SR.

Example 3: Remove from the SmConfig field

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