Get-XenHostPatchProperty

Last published : Nov 12, 2026
\[Deprecated\] Gets a property of a HostPatch object.
Related information
HostPatch cmdlets

Syntax

Get-XenHostPatchProperty [-HostPatch] <Host_patch>
    -XenProperty {Uuid | NameLabel | NameDescription | Version | Host | Applied | TimestampApplied | Size | PoolPatch | OtherConfig}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenHostPatchProperty [-Ref] <XenRef[Host_patch]>
    -XenProperty {Uuid | NameLabel | NameDescription | Version | Host | Applied | TimestampApplied | Size | PoolPatch | OtherConfig}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

DEPRECATED. This class has been deprecated.
Gets a specified property of a HostPatch object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given host\_patch.
NameLabel: Get the name/label field of the given host\_patch.
NameDescription: Get the name/description field of the given host\_patch.
Version: Get the version field of the given host\_patch.
Host: Get the host field of the given host\_patch.
Applied: Get the applied field of the given host\_patch.
TimestampApplied: Get the timestamp\_applied field of the given host\_patch.
Size: Get the size field of the given host\_patch.
PoolPatch: Get the pool\_patch field of the given host\_patch.
OtherConfig: Get the other\_config field of the given host\_patch.

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

-HostPatch

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

-Ref

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenHostPatchProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, Version, Host, Applied, TimestampApplied, Size, PoolPatch, OtherConfig

Inputs

  • Host_patch
  • XenRef[Host_patch]

Outputs

  • System.Object

Examples

Example 1: Get the Version property

PS> Get-XenHostPatch -Name "Demo HostPatch" | Get-XenHostPatchProperty -XenProperty Version
Gets the Version property of a HostPatch.

Example 2: Get the Host property

PS> Get-XenHostPatch -Name "Demo HostPatch" | Get-XenHostPatchProperty -XenProperty Host
Gets the Host property of a HostPatch.

Example 3: Get the Applied property

PS> Get-XenHostPatch -Name "Demo HostPatch" | Get-XenHostPatchProperty -XenProperty Applied
Gets the Applied property of a HostPatch.