Get-XenConsoleProperty
Gets a property of a Console object.
Syntax
Get-XenConsoleProperty [-Console] <Console>
-XenProperty {Uuid | Protocol | Location | VM | OtherConfig} [-BestEffort]
[-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenConsoleProperty [-Ref] <XenRef[Console]>
-XenProperty {Uuid | Protocol | Location | VM | OtherConfig} [-BestEffort]
[-SessionOpaqueRef <string>] [<CommonParameters>]
Description
Gets a specified property of a Console object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given console.
Protocol: Get the protocol field of the given console.
Location: Get the location field of the given console.
VM: Get the VM field of the given console.
OtherConfig: Get the other\_config field of the given console.
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 |
-Console
The Console object to operate on.
| Attribute | Value |
|---|---|
| Type | Console |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-Ref
The Console object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[Console] |
| 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 | XenConsoleProperty |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Uuid, Protocol, Location, VM, OtherConfig |
Inputs
-
Console -
XenRef[Console]
Outputs
-
System.Object
Examples
Example 1: Get the Protocol property
PS> Get-XenConsole -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenConsoleProperty -XenProperty Protocol
Gets the Protocol property of a Console.
Example 2: Get the Location property
PS> Get-XenConsole -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenConsoleProperty -XenProperty Location
Gets the Location property of a Console.
Example 3: Get the VM property
PS> Get-XenConsole -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenConsoleProperty -XenProperty VM
Gets the VM property of a Console.
Related links
-
Class: Console
-
Using the XenServer PowerShell module