Get-NlbClusterPortRule
Get-NlbClusterPortRule
Retrieves the port rule objects that are queried by the caller.
Syntax
Get-NlbClusterPortRule [-HostName <string>] [-InterfaceName <string>] [-NodeName <string>] [[-Port] <System.Nullable`1[[System.UInt32>] [-Ip <IPAddress>] [<CommonParameters>]
Get-NlbClusterPortRule -InputObject <PSObject[]> [[-Port] <System.Nullable`1[[System.UInt32>] [-Ip <IPAddress>] [<CommonParameters>]
Detailed Description
The Get-NlbClusterPortRule cmdlet retrieves the port rules in the NLB cluster. If no port number is specified, all port rules configured for the cluster are listed.
Parameters
-HostName <string>
Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or if "-HostName ." is used, the local cluster is assumed. [Alias: hn]
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-InputObject <PSObject[]>
Specifies the cluster or cluster node for which port rules are enumerated.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Position? |
named |
-InterfaceName <string>
Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-Ip <IPAddress>
Specifies the IP address for the cluster port rule that will be retrieved.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-NodeName <string>
Specifies the name of the cluster node for which port rules are enumerated. [Alias: nn]
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-Port <System.Nullable`1[[System.UInt32>
Specifies a port number within the port rule to retrieve. The valid range is between 0 and 65535.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
1 |
-CommonParameter
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Examples
EXAMPLE 1
C:\PS>
Get-NlbClusterPortRule
IPAddress State Start End Protocol Mode Affinity Timeout
--------- ----- ----- --- -------- ---- -------- -------
All Enabled 0 65535 Both Multiple Single 0
Description
-----------
This command lists all the port rules on the local cluster.
EXAMPLE 2
C:\PS>
Get-NlbClusterPortRule 80
IPAddress State Start End Protocol Mode Affinity Timeout
--------- ----- ----- --- -------- ---- -------- -------
All Enabled 0 65535 Both Multiple Single 0
Description
-----------
This command gets the port rule that includes port 80.
EXAMPLE 3
C:\PS>
Get-NlbClusterNode | Get-NlbClusterPortRule | fl *
Cluster : mycluster
NodeName : node1
VirtualIPAddress : 255.255.255.255
StartPort : 0
EndPort : 65535
Affinity :
FilteringMode : Single
Protocol : Both
EqualLoad : False
LoadWeight :
PortState : Enabled
Priority : 1
Timeout :
Cluster : mycluster
NodeName : node2
VirtualIPAddress : 255.255.255.255
StartPort : 0
EndPort : 65535
Affinity :
FilteringMode : Single
Protocol : Both
EqualLoad : False
LoadWeight :
PortState : Enabled
Priority : 2
Timeout :
Description
-----------
This command gets the port rule from all cluster nodes. This is especially useful if there are port rules that have Single mode.
See Also
Reference
Add-NlbClusterPortRule
Disable-NlbClusterPortRule
Enable-NlbClusterPortRule
Remove-NlbClusterPortRule
Set-NlbClusterPortRule