Export (0) Print
Expand All
Expand Minimize

Set-ClusterParameter

Updated: August 15, 2012

Applies To: Windows Server 2012

Set-ClusterParameter

Controls specific properties of an object in a failover cluster, such as a resource, a group, or a network.

Syntax

Parameter Set: InputObject
Set-ClusterParameter [[-Name] <String> ] [[-Value] <PSObject> ] [-Cluster <String> ] [-Create] [-Delete] [-InputObject <PSObject> ] [-Multiple <hashtable> ] [ <CommonParameters>]




Detailed Description

The Set-ClusterParameter cmdlet controls specific properties of an object in a failover cluster, such as a resource, a group, or a network.
-- For a disk resource, you can set the disk signature or GUID of a disk, and turn maintenance on or off for that disk.
-- For a Network Name resource, you can set DNS-related information about the resource.
-- For an IP address resource, you can set DHCP-related information about the IP Address resource.
-- For resources used by virtual machines, you can set details about the settings for the virtual machines.

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

-Create

Causes the cmdlet to create the parameter on the cluster object, if it does not already exist.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Delete

Causes the cmdlet to delete the parameter from the cluster object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<PSObject>

Specifies the cluster object for which to set the parameters.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Multiple<hashtable>

Allows multiple cluster parameters to be set simultaneously. These parameters are provided in the form of a hashtable.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the cluster parameter to set.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Value<PSObject>

Specifies the value to be set for the cluster parameter.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.FailoverClusters.PowerShell.Cluster
  • Microsoft.FailoverClusters.PowerShell.ClusterGroup
  • Microsoft.FailoverClusters.PowerShell.ClusterNetwork
  • Microsoft.FailoverClusters.PowerShell.ClusterNetworkInterface
  • Microsoft.FailoverClusters.PowerShell.ClusterNode
  • Microsoft.FailoverClusters.PowerShell.ClusterParameter
  • Microsoft.FailoverClusters.PowerShell.ClusterResource
  • Microsoft.FailoverClusters.PowerShell.ClusterResourceType
  • Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume

Examples

Example 1

This example configures the clustered resource called cluster1FS on the local cluster, by setting the value of HostRecordTTL to 300.


PS C:\> Get-ClusterResource –Name cluster1FS | Set-ClusterParameter –Name HostRecordTTL –Value 300

Example 2

This example uses the Multiple parameter to configure the clustered resource called Cluster IP Address, by setting the Address, Network, and EnableDhcp parameters simultaneously.


PS C:\> Get-ClusterResource –Name "Cluster IP Address" | Set-ClusterParameter -Multiple @{"Address"="172.24.22.168";"Network"="Cluster Network 2";"EnableDhcp"=1}

Example 3

This example configures the clustered resource called IP Address to use a new static IP. Because the new address and subnet mask are required, both parameters must be passed to this cmdlet together.


 

PS C:\> $res = Get-ClusterResource –Name "IP Address"

 

PS C:\> $param1 = New-Object –ComObject Microsoft.FailoverClusters.PowerShell.ClusterParameter –Property $res,Address,10.55.88.46

 

PS C:\> $param2 = New-Object –ComObject Microsoft.FailoverClusters.PowerShell.ClusterParameter –Property $res,SubnetMask,255.0.0.0

 

PS C:\> $params = $param1,$param2

 

PS C:\> $params | Set-ClusterParameter

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft