New-XenVLAN

Last published : Nov 12, 2026
Creates a new VLAN object.
Related information
VLAN cmdlets

Syntax

New-XenVLAN -HashTable <hashtable> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenVLAN -Record <VLAN> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenVLAN [-PassThru] [-TaggedPIF <XenRef[PIF]>] [-Tag <long>]
    [-Network <XenRef[Network]>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [-Async] [<CommonParameters>]

Description

Creates a new VLAN object.
VLAN.create: Create a VLAN mux/demuxer.
VLAN: A VLAN mux/demux.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-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

-Confirm

Prompts for confirmation before running the cmdlet.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases cf

-HashTable

A hashtable of field names to values, from which to create the VLAN.
Attribute Value
Type hashtable
Required True
Position Named
Accepts pipeline input False

-Network

Network to receive the untagged traffic
Attribute Value
Type XenRef[Network]
Required False
Position Named
Accepts pipeline input False

-PassThru

If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Record

An existing VLAN record whose fields are used to create the new object.
Attribute Value
Type VLAN
Required True
Position Named
Accepts pipeline input False

-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

-Tag

VLAN tag to use
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-TaggedPIF

PIF which receives the tagged traffic
Attribute Value
Type XenRef[PIF]
Required False
Position Named
Accepts pipeline input False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases wi

Inputs

  • None

Outputs

  • VLAN
  • Task
  • void

Examples

Example 1: Create a VLAN

PS> $pif = Get-XenPIF | Select-Object -First 1
PS> $network = Get-XenNetwork | Select-Object -First 1
PS> New-XenVLAN -TaggedPIF $pif -Tag 0 -Network $network -PassThru
New-XenVLAN takes the arguments of the create call rather than a record of fields, and needs all of them. -PassThru returns the new VLAN.

Example 2: Create a VLAN and wait for the task

PS> $pif = Get-XenPIF | Select-Object -First 1
PS> $network = Get-XenNetwork | Select-Object -First 1
PS> New-XenVLAN -TaggedPIF $pif -Tag 0 -Network $network -Async -PassThru |
    Wait-XenTask -ShowProgress
-Async hands the work to the server and returns the Task that represents it, which pipes into Wait-XenTask.

Example 3: See what would be created

PS> $pif = Get-XenPIF | Select-Object -First 1
PS> $network = Get-XenNetwork | Select-Object -First 1
PS> New-XenVLAN -TaggedPIF $pif -Tag 0 -Network $network -WhatIf
Reports what would be created without creating it. Every cmdlet that changes the server takes -WhatIf and -Confirm.
  • VLAN cmdlets
  • Class: VLAN
  • Using the XenServer PowerShell module