Update-ClusterIPResource
Update-ClusterIPResource
Renews or releases the DHCP lease for an IP address resource in a failover cluster.
Syntax
Parameter Set: InputObject
Update-ClusterIPResource [[-Name] <String> ] [-Cluster <String> ] [-InputObject <PSObject> ] [-Release] [-Renew] [ <CommonParameters>]
Detailed Description
The Update-ClusterIPResource cmdlet renews or releases the DHCP lease for an IP address resource in a failover cluster. This cmdlet applies only to IP address resources that use DHCP.
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 |
-InputObject<PSObject>
Specifies the cluster IP address resource to update.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the cluster IP address resource to update.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Release
Causes the cmdlet to release the DHCP lease of the IP address resource.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Renew
Causes the cmdlet to renew the DHCP lease of the IP address resource.
Aliases |
none |
Required? |
false |
Position? |
named |
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.FailoverClusters.PowerShell.ClusterResource
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.FailoverClusters.PowerShell.ClusterResource
Examples
Example 1
This example updates the DHCP lease for the resource called Cluster IP Address if this resource is DHCP assigned.
PS C:\> Update-ClusterIPResource –Name "Cluster IP Address"
Example 2
This example updates the DHCP lease for all of the clustered IP resources that are DHCP assigned.
PS C:\> Get-ClusterResource | Where-Object –FilterScript {$_.ResourceType.Name -eq "IP Address"} | Update-ClusterIPResource
Example 3
This example takes the resource named IP Address 172.24.11.0 offline, and releases the DHCP lease for that resource.
PS C:\> Get-ClusterResource –Name "IP Address 172.24.11.0" | Stop-ClusterResource | Update-ClusterIPResource -Release