Update-ClusterVirtualMachineConfiguration
Refreshes the configuration of a clustered virtual machine within a failover cluster.
Syntax
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the clustered virtual machine resource to update.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the clustered virtual machine resource to update.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMId
Specifies the virtual machine identifier (ID).
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.