Remove-XenTunnelProperty

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

Syntax

Remove-XenTunnelProperty [-Tunnel] <Tunnel> [-PassThru] [-Status <string>]
    [-OtherConfig <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]
Remove-XenTunnelProperty [-Ref] <XenRef[Tunnel]> [-PassThru] [-Status <string>]
    [-OtherConfig <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]
Remove-XenTunnelProperty [-Uuid] <guid> [-PassThru] [-Status <string>]
    [-OtherConfig <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]

Description

Removes values from the collection-valued fields of a Tunnel. Each optional parameter listed below corresponds to a field that can be removed from.

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

Remove the given key and its corresponding value from the other\_config field of the given tunnel. If the key is not in that Map, then do nothing.
Attribute Value
Type string
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

-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

Remove the given key and its corresponding value from the status field of the given tunnel. If the key is not in that Map, then do nothing.
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)

-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

Examples

Example 1: Remove from the Status field

PS> Remove-XenTunnelProperty -Status "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Removes a value from the Status field of a Tunnel.

Example 2: Remove from the OtherConfig field

PS> Remove-XenTunnelProperty -OtherConfig "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Removes a value from the OtherConfig field of a Tunnel.

Example 3: Remove from the Status field piped from the getter

PS> Get-XenTunnel -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Remove-XenTunnelProperty -Status "value"
Removes a value from the Status field of a Tunnel. The object is piped in, which is the usual way once you already have it.