Edit

Share via


Update-ClusterIPResource

Renews or releases the DHCP lease for an IP address resource in a failover cluster.

Syntax

Default (Default)

Update-ClusterIPResource
    [[-Name] <String>]
    [-Renew]
    [-Release]
    [-InputObject <PSObject>]
    [-Cluster <String>]
    [<CommonParameters>]

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.

Examples

Example 1: Update DHCP lease

Update-ClusterIPResource -Name "Cluster IP Address"

This example updates the DHCP lease for the resource called Cluster IP Address if this resource is DHCP assigned.

Example 2: Update DHCP leases for all clustered IP resources

$clusterIP = Get-ClusterResource | Where-Object {$_.ResourceType.Name -eq "IP Address"}
$clusterIP | Update-ClusterIPResource

This example updates the DHCP lease for all of the clustered IP resources that are DHCP assigned.

Example 3: Take a resource offline and release its lease

$clusterResource = Get-ClusterResource -Name "IP Address 10.24.11.0"
$clusterResource | Stop-ClusterResource | Update-ClusterIPResource -Release

This example takes the resource named IP Address 172.24.11.0 offline, and releases the DHCP lease for that resource.

Parameters

-Cluster

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.

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

-InputObject

Specifies the cluster IP address resource to update.

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

-Name

Specifies the name of the cluster IP address resource to update.

Parameter properties

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

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Release

Causes the cmdlet to release the DHCP lease of the IP address resource.

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

-Renew

Causes the cmdlet to renew the DHCP lease of the IP address resource.

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

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.ClusterResource

Outputs

Microsoft.FailoverClusters.PowerShell.ClusterResource