Get-XenVLANProperty

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

Syntax

Get-XenVLANProperty [-VLAN] <VLAN>
    -XenProperty {Uuid | TaggedPIF | UntaggedPIF | Tag | OtherConfig} [-BestEffort]
    [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVLANProperty [-Ref] <XenRef[VLAN]>
    -XenProperty {Uuid | TaggedPIF | UntaggedPIF | Tag | OtherConfig} [-BestEffort]
    [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a VLAN object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VLAN.
TaggedPIF: Get the tagged\_PIF field of the given VLAN.
UntaggedPIF: Get the untagged\_PIF field of the given VLAN.
Tag: Get the tag field of the given VLAN.
OtherConfig: Get the other\_config field of the given VLAN.

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

-VLAN

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenVLANProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, TaggedPIF, UntaggedPIF, Tag, OtherConfig

Inputs

  • VLAN
  • XenRef[VLAN]

Outputs

  • System.Object

Examples

Example 1: Get the TaggedPIF property

PS> Get-XenVLAN -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVLANProperty -XenProperty TaggedPIF
Gets the TaggedPIF property of a VLAN.

Example 2: Get the UntaggedPIF property

PS> Get-XenVLAN -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVLANProperty -XenProperty UntaggedPIF
Gets the UntaggedPIF property of a VLAN.

Example 3: Get the Tag property

PS> Get-XenVLAN -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVLANProperty -XenProperty Tag
Gets the Tag property of a VLAN.
  • VLAN cmdlets
  • Class: VLAN
  • Using the XenServer PowerShell module