Add-XenNetwork

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

Syntax

Add-XenNetwork [-Network] <Network> [-PassThru]
    [-OtherConfig <KeyValuePair[string, string]>] [-Tags <string>]
    [-Purpose {nbd | insecure_nbd | unknown}] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenNetwork [-Ref] <XenRef[Network]> [-PassThru]
    [-OtherConfig <KeyValuePair[string, string]>] [-Tags <string>]
    [-Purpose {nbd | insecure_nbd | unknown}] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenNetwork [-Uuid] <guid> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
    [-Tags <string>] [-Purpose {nbd | insecure_nbd | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenNetwork [-Name] <string> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
    [-Tags <string>] [-Purpose {nbd | insecure_nbd | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Adds values to the collection-valued fields of a Network. Each optional parameter listed below corresponds to a field that can be added to.

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

-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

-Network

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

-OtherConfig

Add the given key-value pair to the other\_config field of the given network.
Attribute Value
Type KeyValuePair[string, 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

-Purpose

Give a network a new purpose (if not present already)
Attribute Value
Type network_purpose
Required False
Position Named
Accepts pipeline input False
Accepted values nbd, insecure_nbd, unknown

-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

Add the given value to the tags field of the given network. If the value is already in that Set, then do nothing.
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: Add to the OtherConfig field

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenNetwork -OtherConfig $entry -Name "Demo Network"
Adds a value to the OtherConfig field of a Network. The parameter takes one entry of the map; a hashtable does not bind to it.

Example 2: Add to the Tags field

PS> Add-XenNetwork -Tags "value" -Name "Demo Network"
Adds a value to the Tags field of a Network.

Example 3: Add a purpose

PS> Add-XenNetwork -Purpose nbd -Name "Demo Network"
Give a network a new purpose (if not present already)