Get-XenSMProperty

Last published : Nov 12, 2026
Gets a property of an SM object.
Related information
SM cmdlets

Syntax

Get-XenSMProperty [-SM] <SM>
    -XenProperty {Uuid | NameLabel | NameDescription | Type | Vendor | Copyright | Version | RequiredApiVersion | Configuration | Capabilities | Features | OtherConfig | DriverFilename | RequiredClusterStack | SupportedImageFormats}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenSMProperty [-Ref] <XenRef[SM]>
    -XenProperty {Uuid | NameLabel | NameDescription | Type | Vendor | Copyright | Version | RequiredApiVersion | Configuration | Capabilities | Features | OtherConfig | DriverFilename | RequiredClusterStack | SupportedImageFormats}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of an SM object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given SM.
NameLabel: Get the name/label field of the given SM.
NameDescription: Get the name/description field of the given SM.
Type: Get the type field of the given SM.
Vendor: Get the vendor field of the given SM.
Copyright: Get the copyright field of the given SM.
Version: Get the version field of the given SM.
RequiredApiVersion: Get the required\_api\_version field of the given SM.
Configuration: Get the configuration field of the given SM.
Capabilities: Get the capabilities field of the given SM. (Deprecated.)
Features: Get the features field of the given SM.
OtherConfig: Get the other\_config field of the given SM.
DriverFilename: Get the driver\_filename field of the given SM.
RequiredClusterStack: Get the required\_cluster\_stack field of the given SM.
SupportedImageFormats: Get the supported\_image\_formats field of the given SM.

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

-Ref

The SM object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[SM]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SM

The SM object to operate on.
Attribute Value
Type SM
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

-XenProperty

Selects which property to use.
Attribute Value
Type XenSMProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, Type, Vendor, Copyright, Version, RequiredApiVersion, Configuration, Capabilities, Features, OtherConfig, DriverFilename, RequiredClusterStack, SupportedImageFormats

Inputs

  • SM
  • XenRef[SM]

Outputs

  • System.Object

Examples

Example 1: Get the Type property

PS> Get-XenSM -Name "Demo SM" | Get-XenSMProperty -XenProperty Type
Gets the Type property of an SM.

Example 2: Get the Vendor property

PS> Get-XenSM -Name "Demo SM" | Get-XenSMProperty -XenProperty Vendor
Gets the Vendor property of an SM.
  • SM cmdlets
  • Class: SM
  • Using the XenServer PowerShell module