Update-ClusterVirtualMachineConfiguration
Update-ClusterVirtualMachineConfiguration
Refreshes the configuration of a clustered virtual machine within a failover cluster.
Syntax
Parameter Set: InputObject
Update-ClusterVirtualMachineConfiguration [[-Name] <String> ] [-Cluster <String> ] [-InputObject <PSObject> ] [-VMId <Guid> ] [ <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 |
none |
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 |
none |
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 |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMId<Guid>
Specifies the virtual machine identifier (ID).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.FailoverClusters.PowerShell.ClusterResource
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.FailoverClusters.PowerShell.ClusterResource
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"
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