Get-XenTunnelProperty

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

Syntax

Get-XenTunnelProperty [-Tunnel] <Tunnel>
    -XenProperty {Uuid | AccessPIF | TransportPIF | Status | OtherConfig | Protocol}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenTunnelProperty [-Ref] <XenRef[Tunnel]>
    -XenProperty {Uuid | AccessPIF | TransportPIF | Status | OtherConfig | Protocol}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a Tunnel object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given tunnel.
AccessPIF: Get the access\_PIF field of the given tunnel.
TransportPIF: Get the transport\_PIF field of the given tunnel.
Status: Get the status field of the given tunnel.
OtherConfig: Get the other\_config field of the given tunnel.
Protocol: Get the protocol field of the given tunnel.

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 Tunnel object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Tunnel]
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

-Tunnel

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenTunnelProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, AccessPIF, TransportPIF, Status, OtherConfig, Protocol

Inputs

  • Tunnel
  • XenRef[Tunnel]

Outputs

  • System.Object

Examples

Example 1: Get the AccessPIF property

PS> Get-XenTunnel -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenTunnelProperty -XenProperty AccessPIF
Gets the AccessPIF property of a Tunnel.

Example 2: Get the TransportPIF property

PS> Get-XenTunnel -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenTunnelProperty -XenProperty TransportPIF
Gets the TransportPIF property of a Tunnel.

Example 3: Get the Status property

PS> Get-XenTunnel -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenTunnelProperty -XenProperty Status
Gets the Status property of a Tunnel.