Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Update-ClusterVirtualMachineConfiguration

Update-ClusterVirtualMachineConfiguration

microsoft.failoverclusters.powershell.dll

Synopsis

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

Syntax

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

Detailed 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.

Parameters

-Cluster <String>

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.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <PSObject>

Specifies the clustered virtual machine resource to update.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Name <String>

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

Aliases

None

Required?

false

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-VMId <Guid>

Specifies the virtual machine identifier (ID).

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

Input Type

Microsoft.FailoverClusters.PowerShell.ClusterResource

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterResource

Notes

None

Examples

EXAMPLE 1

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

PS C:\>Update-ClusterVirtualMachineConfiguration –Name "Virtual Machine Configuration VM1"
Name                State               Group               ResourceType 
----                -----               -----               ------------ 
Virtual Machine ... Online              Virtual Machine     Virtual Machine ... 

EXAMPLE 2

This example refreshes the clustered virtual machine named Virtual Machine Configuration VM2 on the cluster named cluster1.

PS C:\>Update-ClusterVirtualMachineConfiguration –Name "Virtual Machine Configuration VM2" -Cluster cluster1
Name                State               Group               ResourceType 
----                -----               -----               ------------ 
Virtual Machine ... Online              Virtual Machine     Virtual Machine 

Online Version
Add-ClusterVirtualMachineRole
Move-ClusterVirtualMachineRole