Remove-XenVMGuestMetricsProperty

Last published : Nov 12, 2026
Removes values from fields of a VMGuestMetrics object.
Related information
VMGuestMetrics cmdlets

Syntax

Remove-XenVMGuestMetricsProperty [-VMGuestMetrics] <VM_guest_metrics> [-PassThru]
    [-OtherConfig <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]
Remove-XenVMGuestMetricsProperty [-Ref] <XenRef[VM_guest_metrics]> [-PassThru]
    [-OtherConfig <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]
Remove-XenVMGuestMetricsProperty [-Uuid] <guid> [-PassThru] [-OtherConfig <string>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Removes values from the collection-valued fields of a VMGuestMetrics. 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

-OtherConfig

Remove the given key and its corresponding value from the other\_config field of the given VM\_guest\_metrics. 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 VMGuestMetrics object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[VM_guest_metrics]
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 VMGuestMetrics to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-VMGuestMetrics

The VMGuestMetrics object to operate on.
Attribute Value
Type VM_guest_metrics
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

  • VM_guest_metrics
  • XenRef[VM_guest_metrics]
  • guid

Outputs

  • VM_guest_metrics

Examples

Example 1: Remove from the OtherConfig field

PS> Remove-XenVMGuestMetricsProperty -OtherConfig "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Removes a value from the OtherConfig field of a VMGuestMetrics.

Example 2: Remove from the OtherConfig field piped from the getter

PS> Get-XenVMGuestMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Remove-XenVMGuestMetricsProperty -OtherConfig "value"
Removes a value from the OtherConfig field of a VMGuestMetrics. The object is piped in, which is the usual way once you already have it.

Example 3: Remove from the OtherConfig field by reference

PS> Remove-XenVMGuestMetricsProperty -OtherConfig "value" -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Removes a value from the OtherConfig field of a VMGuestMetrics. -Ref takes the opaque reference, which is what the API itself uses and what the records hold.