Get-XenVIFProperty
Gets a property of a VIF object.
Syntax
Get-XenVIFProperty [-VIF] <VIF>
-XenProperty {Uuid | AllowedOperations | CurrentOperations | Device | Network | VM | MAC | MTU | OtherConfig | CurrentlyAttached | StatusCode | StatusDetail | RuntimeProperties | QosAlgorithmType | QosAlgorithmParams | QosSupportedAlgorithms | Metrics | MACAutogenerated | LockingMode | Ipv4Allowed | Ipv6Allowed | Ipv4ConfigurationMode | Ipv4Addresses | Ipv4Gateway | Ipv6ConfigurationMode | Ipv6Addresses | Ipv6Gateway | Trunks}
[-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVIFProperty [-Ref] <XenRef[VIF]>
-XenProperty {Uuid | AllowedOperations | CurrentOperations | Device | Network | VM | MAC | MTU | OtherConfig | CurrentlyAttached | StatusCode | StatusDetail | RuntimeProperties | QosAlgorithmType | QosAlgorithmParams | QosSupportedAlgorithms | Metrics | MACAutogenerated | LockingMode | Ipv4Allowed | Ipv6Allowed | Ipv4ConfigurationMode | Ipv4Addresses | Ipv4Gateway | Ipv6ConfigurationMode | Ipv6Addresses | Ipv6Gateway | Trunks}
[-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Description
Gets a specified property of a VIF object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VIF.
AllowedOperations: Get the allowed\_operations field of the given VIF.
CurrentOperations: Get the current\_operations field of the given VIF.
Device: Get the device field of the given VIF.
Network: Get the network field of the given VIF.
VM: Get the VM field of the given VIF.
MAC: Get the MAC field of the given VIF.
MTU: Get the MTU field of the given VIF.
OtherConfig: Get the other\_config field of the given VIF.
CurrentlyAttached: Get the currently\_attached field of the given VIF.
StatusCode: Get the status\_code field of the given VIF.
StatusDetail: Get the status\_detail field of the given VIF.
RuntimeProperties: Get the runtime\_properties field of the given VIF.
QosAlgorithmType: Get the qos/algorithm\_type field of the given VIF.
QosAlgorithmParams: Get the qos/algorithm\_params field of the given VIF.
QosSupportedAlgorithms: Get the qos/supported\_algorithms field of the given VIF.
Metrics: Get the metrics field of the given VIF. (Removed.)
MACAutogenerated: Get the MAC\_autogenerated field of the given VIF.
LockingMode: Get the locking\_mode field of the given VIF.
Ipv4Allowed: Get the ipv4\_allowed field of the given VIF.
Ipv6Allowed: Get the ipv6\_allowed field of the given VIF.
Ipv4ConfigurationMode: Get the ipv4\_configuration\_mode field of the given VIF.
Ipv4Addresses: Get the ipv4\_addresses field of the given VIF.
Ipv4Gateway: Get the ipv4\_gateway field of the given VIF.
Ipv6ConfigurationMode: Get the ipv6\_configuration\_mode field of the given VIF.
Ipv6Addresses: Get the ipv6\_addresses field of the given VIF.
Ipv6Gateway: Get the ipv6\_gateway field of the given VIF.
Trunks: Get the trunks field of the given VIF.
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 |
-Ref
The VIF object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[VIF] |
| 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 |
-VIF
The VIF object to operate on.
| Attribute | Value |
|---|---|
| Type | VIF |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-XenProperty
Selects which property to use.
| Attribute | Value |
|---|---|
| Type | XenVIFProperty |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Uuid, AllowedOperations, CurrentOperations, Device, Network, VM, MAC, MTU, OtherConfig, CurrentlyAttached, StatusCode, StatusDetail, RuntimeProperties, QosAlgorithmType, QosAlgorithmParams, QosSupportedAlgorithms, Metrics, MACAutogenerated, LockingMode, Ipv4Allowed, Ipv6Allowed, Ipv4ConfigurationMode, Ipv4Addresses, Ipv4Gateway, Ipv6ConfigurationMode, Ipv6Addresses, Ipv6Gateway, Trunks |
Inputs
-
VIF -
XenRef[VIF]
Outputs
-
System.Object
Examples
Example 1: Get the AllowedOperations property
PS> Get-XenVIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVIFProperty -XenProperty AllowedOperations
Gets the AllowedOperations property of a VIF.
Example 2: Get the CurrentOperations property
PS> Get-XenVIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVIFProperty -XenProperty CurrentOperations
Gets the CurrentOperations property of a VIF.
Example 3: Get the Device property
PS> Get-XenVIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVIFProperty -XenProperty Device
Gets the Device property of a VIF.
Related links
-
Class: VIF
-
Using the XenServer PowerShell module