Table of contents
TOC
Collapse the table of content
Expand the table of content

Update-ClusterVirtualMachineConfiguration

Last Updated: 3/28/2017

SYNOPSIS

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

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

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

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

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

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
Parameter Sets: (All)
Aliases: 

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

-InputObject

Specifies the clustered virtual machine resource to update.

Type: PSObject
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

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

Type: String
Parameter Sets: (All)
Aliases: 

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

-VMId

Specifies the virtual machine identifier (ID).

Type: Guid
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.FailoverClusters.PowerShell.ClusterResource

OUTPUTS

Microsoft.FailoverClusters.PowerShell.ClusterResource

NOTES

Add-ClusterVirtualMachineRole

Move-ClusterVirtualMachineRole

© 2017 Microsoft