Get-XenNetworkSriovProperty

Last published : Nov 12, 2026
Gets a property of a NetworkSriov object.
Related information
NetworkSriov cmdlets

Syntax

Get-XenNetworkSriovProperty [-NetworkSriov] <Network_sriov>
    -XenProperty {Uuid | PhysicalPIF | LogicalPIF | RequiresReboot | ConfigurationMode | RemainingCapacity}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Get-XenNetworkSriovProperty [-Ref] <XenRef[Network_sriov]>
    -XenProperty {Uuid | PhysicalPIF | LogicalPIF | RequiresReboot | ConfigurationMode | RemainingCapacity}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]

Description

Gets a specified property of a NetworkSriov object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given network\_sriov.
PhysicalPIF: Get the physical\_PIF field of the given network\_sriov.
LogicalPIF: Get the logical\_PIF field of the given network\_sriov.
RequiresReboot: Get the requires\_reboot field of the given network\_sriov.
ConfigurationMode: Get the configuration\_mode field of the given network\_sriov.
RemainingCapacity: Get the number of free SR-IOV VFs on the associated PIF.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
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

-NetworkSriov

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

-Ref

The NetworkSriov object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Network_sriov]
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 XenNetworkSriovProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, PhysicalPIF, LogicalPIF, RequiresReboot, ConfigurationMode, RemainingCapacity

Inputs

  • Network_sriov
  • XenRef[Network_sriov]

Outputs

  • System.Object

Examples

Example 1: Get the PhysicalPIF property

PS> Get-XenNetworkSriov -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenNetworkSriovProperty -XenProperty PhysicalPIF
Gets the PhysicalPIF property of a NetworkSriov.

Example 2: Get the LogicalPIF property

PS> Get-XenNetworkSriov -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenNetworkSriovProperty -XenProperty LogicalPIF
Gets the LogicalPIF property of a NetworkSriov.

Example 3: Get the RequiresReboot property

PS> Get-XenNetworkSriov -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenNetworkSriovProperty -XenProperty RequiresReboot
Gets the RequiresReboot property of a NetworkSriov.