Update-ClusterVirtualMachineConfiguration

Update-ClusterVirtualMachineConfiguration

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

Syntax

Update-ClusterVirtualMachineConfiguration [-InputObject <psobject>] [[-Name] <string>] [-Cluster <string>] [<CommonParameters>]
  • InputObject

  • Name

  • Cluster

Detailed Description

Use this cmdlet if you add or remove a hardware device (such as a network adapter) or change the hardware configuration settings (such as the setting for virtual memory) for a clustered virtual machine.

Parameters

Cluster

Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

InputObject

Specifies the cluster virtual machine resource to update.

Default Value: **

Data Type: psobject

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

true (ByValue)

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Name

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

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

1

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Input Type

Microsoft.FailoverClusters.PowerShell.ClusterResource

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterResource

Examples

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

 
Update-ClusterVirtualMachineConfiguration "Virtual Machine Configuration VM1" 
 
Name                State               Group               ResourceType 
----                -----               -----               ------------ 
Virtual Machine ... Online              Virtual Machine     Virtual Machine ...

Description

-----------

This command refreshes "Virtual Machine Configuration VM1" on the local cluster.

 

-------------------------- EXAMPLE 2 --------------------------

Command Prompt: C:\PS>

 
Update-ClusterVirtualMachineConfiguration "Virtual Machine Configuration VM2" -Cluster cluster1 
 
Name                State               Group               ResourceType 
----                -----               -----               ------------ 
Virtual Machine ... Online              Virtual Machine     Virtual Machine

Description

-----------

This command refreshes "Virtual Machine Configuration VM2" on cluster1.

See Also

Reference

Add-ClusterVirtualMachineRole
Move-ClusterVirtualMachineRole

Other Resources

Online version: