Remove-XenSMProperty
Removes values from fields of an SM object.
Syntax
Remove-XenSMProperty [-SM] <SM> [-PassThru] [-OtherConfig <string>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenSMProperty [-Ref] <XenRef[SM]> [-PassThru] [-OtherConfig <string>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenSMProperty [-Uuid] <guid> [-PassThru] [-OtherConfig <string>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenSMProperty [-Name] <string> [-PassThru] [-OtherConfig <string>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Description
Removes values from the collection-valued fields of an SM. Each optional parameter listed below corresponds to a field that can be removed from.
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 |
-Confirm
Prompts for confirmation before running the cmdlet.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
| Aliases | cf |
-Name
The name of the SM to operate on.
| Attribute | Value |
|---|---|
| Type | string |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | name_label |
-OtherConfig
Remove the given key and its corresponding value from the other\_config field of the given SM. 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 |
-Ref
The SM object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[SM] |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | opaque_ref |
-SM
The SM object to operate on.
| Attribute | Value |
|---|---|
| Type | SM |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-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 SM 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
-
SM -
XenRef[SM] -
guid -
string
Outputs
-
SM
Examples
Example 1: Remove from the OtherConfig field
PS> Remove-XenSMProperty -OtherConfig "value" -Name "Demo SM"
Removes a value from the OtherConfig field of an SM.
Example 2: Remove from the OtherConfig field piped from the getter
PS> Get-XenSM -Name "Demo SM" | Remove-XenSMProperty -OtherConfig "value"
Removes a value from the OtherConfig field of an SM. The object is piped in, which is the usual way once you already have it.
Example 3: Remove from the OtherConfig field by uuid
PS> Remove-XenSMProperty -OtherConfig "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Removes a value from the OtherConfig field of an SM. -Uuid is the way to be sure of exactly one object.
Related links
-
Class: SM
-
Using the XenServer PowerShell module