Get-XenVMSSProperty

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

Syntax

Get-XenVMSSProperty [-VMSS] <VMSS>
    -XenProperty {Uuid | NameLabel | NameDescription | Enabled | Type | RetainedSnapshots | Frequency | Schedule | LastRunTime | VMs}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVMSSProperty [-Ref] <XenRef[VMSS]>
    -XenProperty {Uuid | NameLabel | NameDescription | Enabled | Type | RetainedSnapshots | Frequency | Schedule | LastRunTime | VMs}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a VMSS object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VMSS.
NameLabel: Get the name/label field of the given VMSS.
NameDescription: Get the name/description field of the given VMSS.
Enabled: Get the enabled field of the given VMSS.
Type: Get the type field of the given VMSS.
RetainedSnapshots: Get the retained\_snapshots field of the given VMSS.
Frequency: Get the frequency field of the given VMSS.
Schedule: Get the schedule field of the given VMSS.
LastRunTime: Get the last\_run\_time field of the given VMSS.
VMs: Get the VMs field of the given VMSS.

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

-VMSS

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenVMSSProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, Enabled, Type, RetainedSnapshots, Frequency, Schedule, LastRunTime, VMs

Inputs

  • VMSS
  • XenRef[VMSS]

Outputs

  • System.Object

Examples

Example 1: Get the Enabled property

PS> Get-XenVMSS -Name "Demo VMSS" | Get-XenVMSSProperty -XenProperty Enabled
Gets the Enabled property of a VMSS.

Example 2: Get the Type property

PS> Get-XenVMSS -Name "Demo VMSS" | Get-XenVMSSProperty -XenProperty Type
Gets the Type property of a VMSS.

Example 3: Get the RetainedSnapshots property

PS> Get-XenVMSS -Name "Demo VMSS" | Get-XenVMSSProperty -XenProperty RetainedSnapshots
Gets the RetainedSnapshots property of a VMSS.
  • VMSS cmdlets
  • Class: VMSS
  • Using the XenServer PowerShell module