Edit

Update-ClusterVirtualMachineConfiguration

  • Reference
Module:
FailoverClusters

Refreshes the configuration of a clustered virtual machine within a failover cluster.

Syntax

Update-ClusterVirtualMachineConfiguration
      [[-Name] <String>]
      [-VMId <Guid>]
      [-InputObject <PSObject>]
      [-Cluster <String>]
      [<CommonParameters>]

Description

The Update-ClusterVirtualMachineConfiguration cmdlet refreshes the configuration of a clustered virtual machine within a failover cluster. Use this cmdlet if a hardware device, such as a network adapter, is to be added or removed or the hardware configuration settings, such as the setting for virtual memory, are being changed for a clustered virtual machine.

Examples

Example 1: Refresh a clustered virtual machine on the local cluster

Update-ClusterVirtualMachineConfiguration -Name "Virtual Machine Configuration VM1"

This example refreshes the clustered virtual machine named Virtual Machine Configuration VM1 on the local cluster.

Example 2: Refresh a clustered virtual machine on a cluster

$parameters = @{
    Name = 'Virtual Machine Configuration VM2'
    Cluster = 'cluster1'
}
Update-ClusterVirtualMachineConfiguration @parameters

This example refreshes the clustered virtual machine named Virtual Machine Configuration VM2 on the cluster named cluster1. The example uses splatting to pass parameter values from the $Parameters variable to the command. Learn more about Splatting.

Parameters

-Cluster

Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is . or it is omitted, then the cmdlet runs on the local cluster.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the clustered virtual machine resource to update.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the clustered virtual machine resource to update.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMId

Specifies the virtual machine identifier (ID).

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Microsoft.FailoverClusters.PowerShell.ClusterResource

Outputs

Microsoft.FailoverClusters.PowerShell.ClusterResource