Get-XenNetworkProperty

Last published : Nov 12, 2026
Gets a property of a Network object.

Syntax

Get-XenNetworkProperty [-Network] <Network>
    -XenProperty {Uuid | NameLabel | NameDescription | AllowedOperations | CurrentOperations | VIFs | PIFs | MTU | OtherConfig | Bridge | Managed | Blobs | Tags | DefaultLockingMode | AssignedIps | Purpose}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenNetworkProperty [-Ref] <XenRef[Network]>
    -XenProperty {Uuid | NameLabel | NameDescription | AllowedOperations | CurrentOperations | VIFs | PIFs | MTU | OtherConfig | Bridge | Managed | Blobs | Tags | DefaultLockingMode | AssignedIps | Purpose}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a Network object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given network.
NameLabel: Get the name/label field of the given network.
NameDescription: Get the name/description field of the given network.
AllowedOperations: Get the allowed\_operations field of the given network.
CurrentOperations: Get the current\_operations field of the given network.
VIFs: Get the VIFs field of the given network.
PIFs: Get the PIFs field of the given network.
MTU: Get the MTU field of the given network.
OtherConfig: Get the other\_config field of the given network.
Bridge: Get the bridge field of the given network.
Managed: Get the managed field of the given network.
Blobs: Get the blobs field of the given network.
Tags: Get the tags field of the given network.
DefaultLockingMode: Get the default\_locking\_mode field of the given network.
AssignedIps: Get the assigned\_ips field of the given network.
Purpose: Get the purpose field of the given network.

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

-Network

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

-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

-XenProperty

Selects which property to use.
Attribute Value
Type XenNetworkProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, AllowedOperations, CurrentOperations, VIFs, PIFs, MTU, OtherConfig, Bridge, Managed, Blobs, Tags, DefaultLockingMode, AssignedIps, Purpose

Inputs

  • Network
  • XenRef[Network]

Outputs

  • System.Object

Examples

Example 1: Get the AllowedOperations property

PS> Get-XenNetwork -Name "Demo Network" | Get-XenNetworkProperty -XenProperty AllowedOperations
Gets the AllowedOperations property of a Network.

Example 2: Get the CurrentOperations property

PS> Get-XenNetwork -Name "Demo Network" | Get-XenNetworkProperty -XenProperty CurrentOperations
Gets the CurrentOperations property of a Network.

Example 3: Get the VIFs property

PS> Get-XenNetwork -Name "Demo Network" | Get-XenNetworkProperty -XenProperty VIFs
Gets the VIFs property of a Network.