Set-XenPIF

Last published : Nov 12, 2026
Sets fields of a PIF object.
Related information
PIF cmdlets

Syntax

Set-XenPIF [-PIF] <PIF> [-PassThru] [-OtherConfig <hashtable>]
    [-PrimaryAddressType {IPv4 | IPv6 | unknown}] [-DisallowUnplug <bool>]
    [-Property <string[]>] [-LldpMode {inherited | enabled | disabled | unknown}]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenPIF [-Ref] <XenRef[PIF]> [-PassThru] [-OtherConfig <hashtable>]
    [-PrimaryAddressType {IPv4 | IPv6 | unknown}] [-DisallowUnplug <bool>]
    [-Property <string[]>] [-LldpMode {inherited | enabled | disabled | unknown}]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenPIF [-Uuid] <guid> [-PassThru] [-OtherConfig <hashtable>]
    [-PrimaryAddressType {IPv4 | IPv6 | unknown}] [-DisallowUnplug <bool>]
    [-Property <string[]>] [-LldpMode {inherited | enabled | disabled | unknown}]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Changes writable fields of a PIF. Each optional parameter listed below corresponds to a field that can be set.

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

-DisallowUnplug

Set whether unplugging the PIF is allowed
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-LldpMode

Set the LLDP mode of this PIF, then apply the change by re-plugging the PIF. Only valid for managed physical PIFs.
Attribute Value
Type KeyValuePair[pif_lldp_mode, bool]
Required False
Position Named
Accepts pipeline input False
Accepted values inherited, enabled, disabled, unknown

-OtherConfig

Set the other\_config field of the given PIF.
Attribute Value
Type hashtable
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)

-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

-PrimaryAddressType

Change the primary address type used by this PIF
Attribute Value
Type primary_address_type
Required False
Position Named
Accepts pipeline input False
Accepted values IPv4, IPv6, unknown

-Property

Set the value of a property of the PIF
Attribute Value
Type string[]
Required False
Position Named
Accepts pipeline input False

-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

-Uuid

The UUID of the PIF 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

  • PIF
  • XenRef[PIF]
  • guid

Outputs

  • PIF
  • Task
  • void

Examples

Example 1: Set the OtherConfig field

PS> Get-XenPIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenPIF -OtherConfig @{ "key" = "value" }
Sets the OtherConfig field of a PIF.

Example 2: Set a primaryaddresstype

PS> Get-XenPIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenPIF -PrimaryAddressType IPv4
Change the primary address type used by this PIF

Example 3: Set a disallowunplug

PS> Get-XenPIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenPIF -DisallowUnplug $true
Set whether unplugging the PIF is allowed
  • PIF cmdlets
  • Class: PIF
  • Using the XenServer PowerShell module