Get-XenVMSS

Last published : Nov 12, 2026
Gets the VMSS objects in the pool.
Related information
VMSS cmdlets

Syntax

Get-XenVMSS [[-Ref] <XenRef[VMSS]>] [-BestEffort] [-SessionOpaqueRef <string>]
    [<CommonParameters>]
Get-XenVMSS [-Uuid] <guid> [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVMSS [-Name] <string> [-BestEffort] [-SessionOpaqueRef <string>]
    [<CommonParameters>]

Description

Retrieves the VMSS objects in the pool. With no parameters the cmdlet returns the whole collection; use -Name, -Uuid or -Ref to select one.
VMSS: VM Snapshot Schedule.

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

-Name

The name of the VMSS to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-Ref

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

-Uuid

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

Inputs

  • XenRef[VMSS]
  • guid
  • string

Outputs

  • VMSS[]

Examples

Example 1: List every VMSS

PS> Get-XenVMSS
Retrieves every VMSS object in the pool. With no parameters the cmdlet fetches the whole collection.

Example 2: Retrieve one VMSS by name

PS> Get-XenVMSS -Name "Demo VMSS"
Retrieves a single VMSS. -Name matches on name\_label, which is not unique, so every match is operated on.

Example 3: Retrieve one VMSS by uuid

PS> Get-XenVMSS -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Retrieves a single VMSS. -Uuid is the way to be sure of exactly one object.
  • VMSS cmdlets
  • Class: VMSS
  • Using the XenServer PowerShell module