Set-XenTunnel

Last published : Nov 12, 2026
Sets fields of a Tunnel object.
Related information
Tunnel cmdlets

Syntax

Set-XenTunnel [-Tunnel] <Tunnel> [-PassThru] [-Status <hashtable>]
    [-OtherConfig <hashtable>] [-Protocol {gre | vxlan | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenTunnel [-Ref] <XenRef[Tunnel]> [-PassThru] [-Status <hashtable>]
    [-OtherConfig <hashtable>] [-Protocol {gre | vxlan | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenTunnel [-Uuid] <guid> [-PassThru] [-Status <hashtable>] [-OtherConfig <hashtable>]
    [-Protocol {gre | vxlan | unknown}] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Changes writable fields of a Tunnel. Each optional parameter listed below corresponds to a field that can be set.

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

-Confirm

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

-OtherConfig

Set the other\_config field of the given tunnel.
Attribute Value
Type hashtable
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

Set the protocol field of the given tunnel.
Attribute Value
Type tunnel_protocol
Required False
Position Named
Accepts pipeline input False
Accepted values gre, vxlan, unknown

-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

-Status

Set the status field of the given tunnel.
Attribute Value
Type hashtable
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)

-Uuid

The UUID of the Tunnel to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-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

  • Tunnel
  • XenRef[Tunnel]
  • guid

Outputs

  • Tunnel
  • void

Examples

Example 1: Set the Status field

PS> Get-XenTunnel -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenTunnel -Status @{ "key" = "value" }
Sets the Status field of a Tunnel.

Example 2: Set the OtherConfig field

PS> Get-XenTunnel -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenTunnel -OtherConfig @{ "key" = "value" }
Sets the OtherConfig field of a Tunnel.

Example 3: Set the Protocol field

PS> Get-XenTunnel -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenTunnel -Protocol gre
Sets the Protocol field of a Tunnel.