Set-XenVMGuestMetrics
Sets fields of a VMGuestMetrics object.
Syntax
Set-XenVMGuestMetrics [-VMGuestMetrics] <VM_guest_metrics> [-PassThru]
[-OtherConfig <hashtable>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
[-Confirm] [<CommonParameters>]
Set-XenVMGuestMetrics [-Ref] <XenRef[VM_guest_metrics]> [-PassThru]
[-OtherConfig <hashtable>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
[-Confirm] [<CommonParameters>]
Set-XenVMGuestMetrics [-Uuid] <guid> [-PassThru] [-OtherConfig <hashtable>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Description
Changes writable fields of a VMGuestMetrics. Each optional parameter listed below corresponds to a field that can be set.
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
Set the other\_config field of the given VM\_guest\_metrics.
| 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 |
-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 -
void
Examples
Example 1: Set the OtherConfig field
PS> Get-XenVMGuestMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenVMGuestMetrics -OtherConfig @{ "key" = "value" }
Sets the OtherConfig field of a VMGuestMetrics.
Example 2: Set the OtherConfig field by uuid
PS> Set-XenVMGuestMetrics -OtherConfig @{ "key" = "value" } -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Sets the OtherConfig field of a VMGuestMetrics. -Uuid is the way to be sure of exactly one object.
Example 3: Set the OtherConfig field by reference
PS> Set-XenVMGuestMetrics -OtherConfig @{ "key" = "value" } -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Sets the OtherConfig field of a VMGuestMetrics. -Ref takes the opaque reference, which is what the API itself uses and what the records hold.
Related links
-
Class: VMGuestMetrics
-
Using the XenServer PowerShell module