Remove-XenVIFProperty
Removes values from fields of a VIF object.
Syntax
Remove-XenVIFProperty [-VIF] <VIF> [-PassThru] [-OtherConfig <string>]
[-QosAlgorithmParams <string>] [-Ipv4Allowed <string>] [-Ipv6Allowed <string>]
[-Trunks <long>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Remove-XenVIFProperty [-Ref] <XenRef[VIF]> [-PassThru] [-OtherConfig <string>]
[-QosAlgorithmParams <string>] [-Ipv4Allowed <string>] [-Ipv6Allowed <string>]
[-Trunks <long>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Remove-XenVIFProperty [-Uuid] <guid> [-PassThru] [-OtherConfig <string>]
[-QosAlgorithmParams <string>] [-Ipv4Allowed <string>] [-Ipv6Allowed <string>]
[-Trunks <long>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Description
Removes values from the collection-valued fields of a VIF. Each optional parameter listed below corresponds to a field that can be removed from.
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
Removes an IPv4 address from this VIF
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Ipv6Allowed
Removes an IPv6 address from this VIF
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-OtherConfig
Remove the given key and its corresponding value from the other\_config field of the given VIF. If the key is not in that Map, then do nothing.
| Attribute | Value |
|---|---|
| Type | string |
| 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
Remove the given key and its corresponding value from the qos/algorithm\_params field of the given VIF. If the key is not in that Map, then do nothing.
| 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
Removes a 802.1Q VLAN from this VIF
| 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
Examples
Example 1: Remove from the OtherConfig field
PS> Remove-XenVIFProperty -OtherConfig "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Removes a value from the OtherConfig field of a VIF.
Example 2: Remove from the QosAlgorithmParams field
PS> Remove-XenVIFProperty -QosAlgorithmParams "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Removes a value from the QosAlgorithmParams field of a VIF.
Example 3: Remove an ipv4allowed
PS> Remove-XenVIFProperty -Ipv4Allowed "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Removes an IPv4 address from this VIF
Related links
-
Class: VIF
-
Using the XenServer PowerShell module