Set-XenVIF
Sets fields of a VIF object.
Syntax
Set-XenVIF [-VIF] <VIF> [-PassThru] [-OtherConfig <hashtable>]
[-QosAlgorithmType <string>] [-QosAlgorithmParams <hashtable>]
[-LockingMode {network_default | locked | unlocked | disabled | unknown}]
[-Ipv4Allowed <string[]>] [-Ipv6Allowed <string[]>] [-Trunks <long[]>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenVIF [-Ref] <XenRef[VIF]> [-PassThru] [-OtherConfig <hashtable>]
[-QosAlgorithmType <string>] [-QosAlgorithmParams <hashtable>]
[-LockingMode {network_default | locked | unlocked | disabled | unknown}]
[-Ipv4Allowed <string[]>] [-Ipv6Allowed <string[]>] [-Trunks <long[]>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenVIF [-Uuid] <guid> [-PassThru] [-OtherConfig <hashtable>]
[-QosAlgorithmType <string>] [-QosAlgorithmParams <hashtable>]
[-LockingMode {network_default | locked | unlocked | disabled | unknown}]
[-Ipv4Allowed <string[]>] [-Ipv6Allowed <string[]>] [-Trunks <long[]>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Description
Changes writable fields of a VIF. 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 |
-Ipv4Allowed
Set the IPv4 addresses to which traffic on this VIF can be restricted
| Attribute | Value |
|---|---|
| Type | string[] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Ipv6Allowed
Set the IPv6 addresses to which traffic on this VIF can be restricted
| Attribute | Value |
|---|---|
| Type | string[] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-LockingMode
Set the locking mode for this VIF
| Attribute | Value |
|---|---|
| Type | vif_locking_mode |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | network_default, locked, unlocked, disabled, unknown |
-OtherConfig
Set the other\_config field of the given VIF.
| Attribute | Value |
|---|---|
| Type | hashtable |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-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 |
-QosAlgorithmParams
Set the qos/algorithm\_params field of the given VIF.
| Attribute | Value |
|---|---|
| Type | hashtable |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-QosAlgorithmType
Set the qos/algorithm\_type field of the given VIF.
| Attribute | Value |
|---|---|
| Type | string |
| 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 |
-Trunks
Set the 802.1Q VLANs to which traffic on this VIF can be restricted
| Attribute | Value |
|---|---|
| Type | long[] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Uuid
The UUID of the VIF to operate on.
| Attribute | Value |
|---|---|
| Type | guid |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
-VIF
The VIF object to operate on.
| Attribute | Value |
|---|---|
| Type | VIF |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-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
-
VIF -
XenRef[VIF] -
guid
Outputs
-
VIF -
Task -
void
Examples
Example 1: Set the OtherConfig field
PS> Get-XenVIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenVIF -OtherConfig @{ "key" = "value" }
Sets the OtherConfig field of a VIF.
Example 2: Set the QosAlgorithmType field
PS> Get-XenVIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenVIF -QosAlgorithmType "new value"
Sets the QosAlgorithmType field of a VIF.
Example 3: Set the QosAlgorithmParams field
PS> Get-XenVIF -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenVIF -QosAlgorithmParams @{ "key" = "value" }
Sets the QosAlgorithmParams field of a VIF.
Related links
-
Class: VIF
-
Using the XenServer PowerShell module