Get-XenPIFProperty
Gets a property of a PIF object.
Syntax
Get-XenPIFProperty [-PIF] <PIF>
-XenProperty {Uuid | Device | Network | Host | MAC | MTU | VLAN | Metrics | Physical | CurrentlyAttached | IpConfigurationMode | IP | Netmask | Gateway | DNS | BondSlaveOf | BondMasterOf | VLANMasterOf | VLANSlaveOf | Management | OtherConfig | DisallowUnplug | TunnelAccessPIFOf | TunnelTransportPIFOf | Ipv6ConfigurationMode | IPv6 | Ipv6Gateway | PrimaryAddressType | Managed | Properties | Capabilities | IgmpSnoopingStatus | SriovPhysicalPIFOf | SriovLogicalPIFOf | PCI | LldpMode}
[-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenPIFProperty [-Ref] <XenRef[PIF]>
-XenProperty {Uuid | Device | Network | Host | MAC | MTU | VLAN | Metrics | Physical | CurrentlyAttached | IpConfigurationMode | IP | Netmask | Gateway | DNS | BondSlaveOf | BondMasterOf | VLANMasterOf | VLANSlaveOf | Management | OtherConfig | DisallowUnplug | TunnelAccessPIFOf | TunnelTransportPIFOf | Ipv6ConfigurationMode | IPv6 | Ipv6Gateway | PrimaryAddressType | Managed | Properties | Capabilities | IgmpSnoopingStatus | SriovPhysicalPIFOf | SriovLogicalPIFOf | PCI | LldpMode}
[-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Description
Gets a specified property of a PIF object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given PIF.
Device: Get the device field of the given PIF.
Network: Get the network field of the given PIF.
Host: Get the host field of the given PIF.
MAC: Get the MAC field of the given PIF.
MTU: Get the MTU field of the given PIF.
VLAN: Get the VLAN field of the given PIF.
Metrics: Get the metrics field of the given PIF.
Physical: Get the physical field of the given PIF.
CurrentlyAttached: Get the currently\_attached field of the given PIF.
IpConfigurationMode: Get the ip\_configuration\_mode field of the given PIF.
IP: Get the IP field of the given PIF.
Netmask: Get the netmask field of the given PIF.
Gateway: Get the gateway field of the given PIF.
DNS: Get the DNS field of the given PIF.
BondSlaveOf: Get the bond\_slave\_of field of the given PIF.
BondMasterOf: Get the bond\_master\_of field of the given PIF.
VLANMasterOf: Get the VLAN\_master\_of field of the given PIF.
VLANSlaveOf: Get the VLAN\_slave\_of field of the given PIF.
Management: Get the management field of the given PIF.
OtherConfig: Get the other\_config field of the given PIF.
DisallowUnplug: Get the disallow\_unplug field of the given PIF.
TunnelAccessPIFOf: Get the tunnel\_access\_PIF\_of field of the given PIF.
TunnelTransportPIFOf: Get the tunnel\_transport\_PIF\_of field of the given PIF.
Ipv6ConfigurationMode: Get the ipv6\_configuration\_mode field of the given PIF.
IPv6: Get the IPv6 field of the given PIF.
Ipv6Gateway: Get the ipv6\_gateway field of the given PIF.
PrimaryAddressType: Get the primary\_address\_type field of the given PIF.
Managed: Get the managed field of the given PIF.
Properties: Get the properties field of the given PIF.
Capabilities: Get the capabilities field of the given PIF.
IgmpSnoopingStatus: Get the igmp\_snooping\_status field of the given PIF.
SriovPhysicalPIFOf: Get the sriov\_physical\_PIF\_of field of the given PIF.
SriovLogicalPIFOf: Get the sriov\_logical\_PIF\_of field of the given PIF.
PCI: Get the PCI field of the given PIF.
LldpMode: Get the lldp\_mode field of the given PIF.
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 |
-PIF
The PIF object to operate on.
| Attribute | Value |
|---|---|
| Type | PIF |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-Ref
The PIF object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[PIF] |
| 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 | XenPIFProperty |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Uuid, Device, Network, Host, MAC, MTU, VLAN, Metrics, Physical, CurrentlyAttached, IpConfigurationMode, IP, Netmask, Gateway, DNS, BondSlaveOf, BondMasterOf, VLANMasterOf, VLANSlaveOf, Management, OtherConfig, DisallowUnplug, TunnelAccessPIFOf, TunnelTransportPIFOf, Ipv6ConfigurationMode, IPv6, Ipv6Gateway, PrimaryAddressType, Managed, Properties, Capabilities, IgmpSnoopingStatus, SriovPhysicalPIFOf, SriovLogicalPIFOf, PCI, LldpMode |
Inputs
-
PIF -
XenRef[PIF]
Outputs
-
System.Object
Examples
Example 1: Get the Device property
PS> Get-XenPIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPIFProperty -XenProperty Device
Gets the Device property of a PIF.
Example 2: Get the Network property
PS> Get-XenPIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPIFProperty -XenProperty Network
Gets the Network property of a PIF.
Example 3: Get the Host property
PS> Get-XenPIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPIFProperty -XenProperty Host
Gets the Host property of a PIF.
Related links
-
Class: PIF
-
Using the XenServer PowerShell module