Get-XenCallerProperty

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

Syntax

Get-XenCallerProperty [-Caller] <Caller>
    -XenProperty {Uuid | NameLabel | NameDescription | UserAgent | ClientIp | LastAccess | Groups | RateLimit | AutoRegistered}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenCallerProperty [-Ref] <XenRef[Caller]>
    -XenProperty {Uuid | NameLabel | NameDescription | UserAgent | ClientIp | LastAccess | Groups | RateLimit | AutoRegistered}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a Caller object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given Caller.
NameLabel: Get the name/label field of the given Caller.
NameDescription: Get the name/description field of the given Caller.
UserAgent: Get the user\_agent field of the given Caller.
ClientIp: Get the client\_ip field of the given Caller.
LastAccess: Get the last\_access field of the given Caller.
Groups: Get the groups field of the given Caller.
RateLimit: Get the rate\_limit field of the given Caller.
AutoRegistered: Get the auto\_registered field of the given Caller.

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

-Caller

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

-Ref

The Caller object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Caller]
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 XenCallerProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, UserAgent, ClientIp, LastAccess, Groups, RateLimit, AutoRegistered

Inputs

  • Caller
  • XenRef[Caller]

Outputs

  • System.Object

Examples

Example 1: Get the UserAgent property

PS> Get-XenCaller -Name "Demo Caller" | Get-XenCallerProperty -XenProperty UserAgent
Gets the UserAgent property of a Caller.

Example 2: Get the ClientIp property

PS> Get-XenCaller -Name "Demo Caller" | Get-XenCallerProperty -XenProperty ClientIp
Gets the ClientIp property of a Caller.

Example 3: Get the LastAccess property

PS> Get-XenCaller -Name "Demo Caller" | Get-XenCallerProperty -XenProperty LastAccess
Gets the LastAccess property of a Caller.