Get-XenVTPMProperty

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

Syntax

Get-XenVTPMProperty [-VTPM] <VTPM>
    -XenProperty {Uuid | AllowedOperations | CurrentOperations | VM | Backend | PersistenceBackend | IsUnique | IsProtected}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVTPMProperty [-Ref] <XenRef[VTPM]>
    -XenProperty {Uuid | AllowedOperations | CurrentOperations | VM | Backend | PersistenceBackend | IsUnique | IsProtected}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a VTPM object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VTPM.
AllowedOperations: Get the allowed\_operations field of the given VTPM.
CurrentOperations: Get the current\_operations field of the given VTPM.
VM: Get the VM field of the given VTPM.
Backend: Get the backend field of the given VTPM.
PersistenceBackend: Get the persistence\_backend field of the given VTPM.
IsUnique: Get the is\_unique field of the given VTPM.
IsProtected: Get the is\_protected field of the given VTPM.

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

-VTPM

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenVTPMProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, AllowedOperations, CurrentOperations, VM, Backend, PersistenceBackend, IsUnique, IsProtected

Inputs

  • VTPM
  • XenRef[VTPM]

Outputs

  • System.Object

Examples

Example 1: Get the AllowedOperations property

PS> Get-XenVTPM -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVTPMProperty -XenProperty AllowedOperations
Gets the AllowedOperations property of a VTPM.

Example 2: Get the CurrentOperations property

PS> Get-XenVTPM -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVTPMProperty -XenProperty CurrentOperations
Gets the CurrentOperations property of a VTPM.

Example 3: Get the VM property

PS> Get-XenVTPM -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVTPMProperty -XenProperty VM
Gets the VM property of a VTPM.
  • VTPM cmdlets
  • Class: VTPM
  • Using the XenServer PowerShell module