New-XenTunnel

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

Syntax

New-XenTunnel -HashTable <hashtable> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenTunnel -Record <Tunnel> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenTunnel [-PassThru] [-TransportPIF <XenRef[PIF]>] [-Network <XenRef[Network]>]
    [-Protocol {gre | vxlan | unknown}] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]

Description

Creates a new Tunnel object.
tunnel.create: Create a tunnel.
Tunnel: A tunnel for network traffic.

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 Tunnel.
Attribute Value
Type hashtable
Required True
Position Named
Accepts pipeline input False

-Network

Network to receive the tunnelled 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

-Protocol

Protocol used for the tunnel (GRE or VxLAN)
Attribute Value
Type tunnel_protocol
Required False
Position Named
Accepts pipeline input False
Accepted values gre, vxlan, unknown

-Record

An existing Tunnel record whose fields are used to create the new object.
Attribute Value
Type Tunnel
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

-TransportPIF

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

  • Tunnel
  • Task
  • void

Examples

Example 1: Create a Tunnel

PS> $pif = Get-XenPIF | Select-Object -First 1
PS> $network = Get-XenNetwork | Select-Object -First 1
PS> New-XenTunnel -TransportPIF $pif -Network $network -Protocol gre -PassThru
New-XenTunnel takes the arguments of the create call rather than a record of fields, and needs all of them. -PassThru returns the new Tunnel.

Example 2: Create a Tunnel and wait for the task

PS> $pif = Get-XenPIF | Select-Object -First 1
PS> $network = Get-XenNetwork | Select-Object -First 1
PS> New-XenTunnel -TransportPIF $pif -Network $network -Protocol gre -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-XenTunnel -TransportPIF $pif -Network $network -Protocol gre -WhatIf
Reports what would be created without creating it. Every cmdlet that changes the server takes -WhatIf and -Confirm.