Get-XenUserProperty
\[Deprecated\] Gets a property of a User object.
Syntax
Get-XenUserProperty [-User] <User>
-XenProperty {Uuid | ShortName | Fullname | OtherConfig} [-BestEffort]
[-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenUserProperty [-Ref] <XenRef[User]>
-XenProperty {Uuid | ShortName | Fullname | OtherConfig} [-BestEffort]
[-SessionOpaqueRef <string>] [<CommonParameters>]
Description
DEPRECATED. This class has been deprecated.
Gets a specified property of a User object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given user.
ShortName: Get the short\_name field of the given user.
Fullname: Get the fullname field of the given user.
OtherConfig: Get the other\_config field of the given user.
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 User object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[User] |
| 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 |
-User
The User object to operate on.
| Attribute | Value |
|---|---|
| Type | User |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-XenProperty
Selects which property to use.
| Attribute | Value |
|---|---|
| Type | XenUserProperty |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Uuid, ShortName, Fullname, OtherConfig |
Inputs
-
User -
XenRef[User]
Outputs
-
System.Object
Examples
Example 1: Get the ShortName property
PS> Get-XenUserProperty -XenProperty ShortName -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Gets the ShortName property of a User.
Example 2: Get the Fullname property
PS> Get-XenUserProperty -XenProperty Fullname -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Gets the Fullname property of a User.
Example 3: Get the OtherConfig property
PS> Get-XenUserProperty -XenProperty OtherConfig -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Gets the OtherConfig property of a User.
Related links
-
Class: User
-
Using the XenServer PowerShell module