Get-XenSubject

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

Syntax

Get-XenSubject [[-Ref] <XenRef[Subject]>] [-BestEffort] [-SessionOpaqueRef <string>]
    [<CommonParameters>]
Get-XenSubject [-Uuid] <guid> [-BestEffort] [-SessionOpaqueRef <string>]
    [<CommonParameters>]

Description

Retrieves the Subject objects in the pool. With no parameters the cmdlet returns the whole collection; use -Uuid or -Ref to select one.
Subject: A user or group that can log in xapi.

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 Subject object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Subject]
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 Subject to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

Inputs

  • XenRef[Subject]
  • guid

Outputs

  • Subject[]

Examples

Example 1: List every Subject

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

Example 2: Retrieve one Subject by uuid

PS> Get-XenSubject -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Retrieves a single Subject. -Uuid is the way to be sure of exactly one object.

Example 3: Retrieve one Subject by reference

PS> Get-XenSubject -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Retrieves a single Subject. -Ref takes the opaque reference, which is what the API itself uses and what the records hold.