Edit

Share via


Set-ClusterParameter

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

Syntax

NoMultiple (Default)

Set-ClusterParameter
    [-InputObject <PSObject>]
    [-Create]
    [-Delete]
    [-Cluster <String>]
    [<CommonParameters>]

Single Parameter

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

Multiple Parameter

Set-ClusterParameter
    [[-Multiple] <Hashtable>]
    [-InputObject <PSObject>]
    [-Create]
    [-Delete]
    [-Cluster <String>]
    [<CommonParameters>]

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.

Examples

Example 1

Get-ClusterResource -Name "Cluster Disk 3" | Set-ClusterOwnerNode -Owners node1,node2

This example sets the possible owners for cluster named Cluster Disk 3 on the local cluster to the nodes named node1 and node2.

Example 2

Set-ClusterOwnerNode -Group cluster12FS -Owners node3,node2

This example sets the preferred owners for the clustered service named cluster12FS to the node named node3 followed by the node named node2 on the local cluster.

Parameters

-Cluster

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.

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

-Create

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.

Parameter properties

Type:SwitchParameter
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

-Delete

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.

Parameter properties

Type:SwitchParameter
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

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.

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

-Multiple

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.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Multiple Parameter
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Single Parameter
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Value

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.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Single Parameter
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
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.

Inputs

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