Export (0) Print
Expand All
Expand Minimize

Set-ClusterParameter

Set-ClusterParameter

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

Syntax

Set-ClusterParameter [-InputObject <psobject>] [[-Name] <string>] [[-Value] <psobject>] [-Cluster <string>] [-Create] [-Delete] [<CommonParameters>]
  • InputObject

  • Name

  • Value

  • Cluster

  • Create

  • Delete

Detailed Description

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

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

Create

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

Default Value:

Data Type: SwitchParameter

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?

false

required

Variable Length?

false

variableLength

Delete

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

Default Value:

Data Type: SwitchParameter

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?

false

required

Variable Length?

false

variableLength

InputObject

Specifies the cluster object to set parameters for.

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 parameter to set.

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

Value

Specifies the value to be set for the cluster parameter.

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?

false

pipelineInput

Position?

2

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Input Type

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

Return Type

Examples

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

Command Prompt: C:\PS>
 
Get-ClusterResource cluster1FS | Set-ClusterParameter HostRecordTTL 300

Description

-----------

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

 

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

Command Prompt: C:\PS>
 
$res = Get-ClusterResource "IP Address" 
$param1 = New-Object Microsoft.FailoverClusters.PowerShell.ClusterParameter $res,Address,10.55.88.46 
$param2 = New-Object Microsoft.FailoverClusters.PowerShell.ClusterParameter $res,SubnetMask,255.0.0.0 
$params = $param1,$param2 
$params | Set-ClusterParameter

Description

-----------

This command 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 Set-ClusterParameter together.

See Also

Reference

Get-ClusterParameter

Other Resources

Online version:

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