Get-XenCertificateProperty

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

Syntax

Get-XenCertificateProperty [-Certificate] <Certificate>
    -XenProperty {Uuid | Name | Type | Host | NotBefore | NotAfter | Fingerprint | FingerprintSha256 | FingerprintSha1 | Purpose}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenCertificateProperty [-Ref] <XenRef[Certificate]>
    -XenProperty {Uuid | Name | Type | Host | NotBefore | NotAfter | Fingerprint | FingerprintSha256 | FingerprintSha1 | Purpose}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a Certificate object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given Certificate.
Name: Get the name field of the given Certificate.
Type: Get the type field of the given Certificate.
Host: Get the host field of the given Certificate.
NotBefore: Get the not\_before field of the given Certificate.
NotAfter: Get the not\_after field of the given Certificate.
Fingerprint: Get the fingerprint field of the given Certificate. (Deprecated.)
FingerprintSha256: Get the fingerprint\_sha256 field of the given Certificate.
FingerprintSha1: Get the fingerprint\_sha1 field of the given Certificate.
Purpose: Get the purpose field of the given Certificate.

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

-Certificate

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

-Ref

The Certificate object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Certificate]
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 XenCertificateProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, Name, Type, Host, NotBefore, NotAfter, Fingerprint, FingerprintSha256, FingerprintSha1, Purpose

Inputs

  • Certificate
  • XenRef[Certificate]

Outputs

  • System.Object

Examples

Example 1: Get the Name property

PS> Get-XenCertificate -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenCertificateProperty -XenProperty Name
Gets the Name property of a Certificate.

Example 2: Get the Type property

PS> Get-XenCertificate -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenCertificateProperty -XenProperty Type
Gets the Type property of a Certificate.

Example 3: Get the Host property

PS> Get-XenCertificate -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenCertificateProperty -XenProperty Host
Gets the Host property of a Certificate.