Set-XenNetwork

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

Syntax

Set-XenNetwork [-Network] <Network> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-MTU <long>] [-OtherConfig <hashtable>]
    [-Tags <string[]>] [-DefaultLockingMode {unlocked | disabled | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenNetwork [-Ref] <XenRef[Network]> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-MTU <long>] [-OtherConfig <hashtable>]
    [-Tags <string[]>] [-DefaultLockingMode {unlocked | disabled | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenNetwork [-Uuid] <guid> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-MTU <long>] [-OtherConfig <hashtable>]
    [-Tags <string[]>] [-DefaultLockingMode {unlocked | disabled | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenNetwork [-Name] <string> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-MTU <long>] [-OtherConfig <hashtable>]
    [-Tags <string[]>] [-DefaultLockingMode {unlocked | disabled | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

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

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress. Available only for those fields whose underlying operation supports asynchronous invocation.
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

-DefaultLockingMode

Set the default locking mode for VIFs attached to this network
Attribute Value
Type network_default_locking_mode
Required False
Position Named
Accepts pipeline input False
Accepted values unlocked, disabled, unknown

-MTU

Set the MTU field of the given network.
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-Name

The name of the Network to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-NameDescription

Set the name/description field of the given network.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-NameLabel

Set the name/label field of the given network.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Network

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

-OtherConfig

Set the other\_config field of the given network.
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

-Ref

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

-Tags

Set the tags field of the given network.
Attribute Value
Type string[]
Required False
Position Named
Accepts pipeline input False

-Uuid

The UUID of the Network 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

  • Network
  • XenRef[Network]
  • guid
  • string

Outputs

  • Network
  • Task
  • void

Examples

Example 1: Set the NameLabel field

PS> Get-XenNetwork -Name "Demo Network" | Set-XenNetwork -NameLabel "new value"
Sets the NameLabel field of a Network.

Example 2: Raise a network's MTU for jumbo frames

PS> Get-XenNetwork -Name "storage" | Set-XenNetwork -MTU 9000
The MTU belongs to the network rather than to any one interface, because every NIC and switch along the path has to agree on it. It takes effect as VIFs are replugged.

Example 3: Set the NameDescription field

PS> Get-XenNetwork -Name "Demo Network" | Set-XenNetwork -NameDescription "new value"
Sets the NameDescription field of a Network.