.png)
Update-ClusterIPResource
Update-ClusterIPResource
Renew or release the DHCP lease for an IP address resource in a failover cluster.
Syntax
Update-ClusterIPResource [-InputObject <psobject>] [[-Name] <string>] [-Cluster <string>] [-Release] [-Renew] [<CommonParameters>]
- InputObject
- Name
- Cluster
- Release
- Renew
Detailed Description
This cmdlet applies only to IP Address resources that use DHCP.
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 |
InputObject
Specifies the cluster IP address resource to update.
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 IP address resource to update.
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 |
Release
Causes the cmdlet to release the DHCP lease of the IP address resource.
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 |
Renew
Causes the cmdlet to renew the DHCP lease of the IP address resource.
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 |
Input Type
Microsoft.FailoverClusters.PowerShell.ClusterResource
Return Type
Microsoft.FailoverClusters.PowerShell.ClusterResource
Examples
-------------------------- EXAMPLE 1 --------------------------
Update-ClusterIPResource "Cluster IP Address" Name State Group ResourceType ---- ----- ----- ------------ Cluster IP Address Online Cluster Group IP Address
Description
-----------
This command updates the DHCP lease for the resource called "Cluster IP Address" if this resource is DHCP assigned.
-------------------------- EXAMPLE 2 --------------------------
Get-ClusterResource | ?{ $_.ResourceType.Name -eq "IP Address" } | Update-ClusterIPResource
Name State Group ResourceType
---- ----- ----- ------------
Cluster IP Address Online Cluster Group IP Address
IP Address 172.2... Online cluster1-Other IP Address
IP Address 172.2... Online cluster1-FS IP Address
Description
-----------
This command updates the DHCP lease for all the clustered IP resource(s) that are DHCP assigned.
-------------------------- EXAMPLE 3 --------------------------
Get-ClusterResource "IP Address 172.24.11.0" | Stop-ClusterResource | Update-ClusterIPResource -Release Name State Group ResourceType ---- ----- ----- ------------ IP Address 172.2... Offline cluster1-Other IP Address
Description
-----------
This command takes the resource "IP Address 172.24.11.0" offline, and releases the DHCP lease for that resource.
See Also
