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
PS C:\> Get-ClusterResource -Name cluster1FS | Set-ClusterParameter -Name HostRecordTTL -Value 300
This example configures the clustered resource called cluster1FS on the local cluster, by setting the value of HostRecordTTL to 300.
Example 2
PS C:\> Get-ClusterResource -Name "Cluster IP Address" | Set-ClusterParameter -Multiple @{"Address"="172.24.22.168";"Network"="Cluster Network 2";"EnableDhcp"=1}
This example uses the Multiple parameter to configure the clustered resource called Cluster IP Address, by setting the Address, Network, and EnableDhcp parameters simultaneously.
Example 3
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
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.
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.