Set-XenSR

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

Syntax

Set-XenSR [-SR] <SR> [-PassThru] [-OtherConfig <hashtable>] [-Tags <string[]>]
    [-SmConfig <hashtable>] [-Shared <bool>] [-NameLabel <string>]
    [-NameDescription <string>] [-PhysicalSize <long>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenSR [-Ref] <XenRef[SR]> [-PassThru] [-OtherConfig <hashtable>] [-Tags <string[]>]
    [-SmConfig <hashtable>] [-Shared <bool>] [-NameLabel <string>]
    [-NameDescription <string>] [-PhysicalSize <long>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenSR [-Uuid] <guid> [-PassThru] [-OtherConfig <hashtable>] [-Tags <string[]>]
    [-SmConfig <hashtable>] [-Shared <bool>] [-NameLabel <string>]
    [-NameDescription <string>] [-PhysicalSize <long>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenSR [-Name] <string> [-PassThru] [-OtherConfig <hashtable>] [-Tags <string[]>]
    [-SmConfig <hashtable>] [-Shared <bool>] [-NameLabel <string>]
    [-NameDescription <string>] [-PhysicalSize <long>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Changes writable fields of an SR. Each optional parameter listed below corresponds to a field that can be set.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress. Available only for those fields whose underlying operation supports asynchronous invocation.
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 SR to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-NameDescription

Set the name description of the SR
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-NameLabel

Set the name label of the SR
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-OtherConfig

Set the other\_config field of the given SR.
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

-PhysicalSize

Sets the SR's physical\_size field
Attribute Value
Type long
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

-Shared

Sets the shared flag on the SR
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-SmConfig

Set the sm\_config field of the given SR.
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-Tags

Set the tags field of the given SR.
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
  • Task
  • void

Examples

Example 1: Set the OtherConfig field

PS> Get-XenSR -Name "Demo SR" | Set-XenSR -OtherConfig @{ "key" = "value" }
Sets the OtherConfig field of an SR.

Example 2: Set the Tags field

PS> Get-XenSR -Name "Demo SR" | Set-XenSR -Tags "tag1"
Sets the Tags field of an SR.

Example 3: Set the SmConfig field

PS> Get-XenSR -Name "Demo SR" | Set-XenSR -SmConfig @{ "key" = "value" }
Sets the SmConfig field of an SR.
  • SR cmdlets
  • Class: SR
  • Using the XenServer PowerShell module