Get-NlbClusterPortRule
Get-NlbClusterPortRule
Retrieves the port rule objects that are queried by the caller.
Syntax
Parameter Set: NonPipeline
Get-NlbClusterPortRule [[-Port] <Nullable> ] [-HostName <String> ] [-InterfaceName <String> ] [-IP <IPAddress> ] [-NodeName <String> ] [ <CommonParameters>]
Parameter Set: Pipeline
Get-NlbClusterPortRule [[-Port] <Nullable> ] -InputObject <PSObject> [-IP <IPAddress> ] [ <CommonParameters>]
Detailed Description
The Get-NlbClusterPortRule cmdlet retrieves the port rules in the Network Load Balancing (NLB) cluster. If a port number is not 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 a value of . is entered, then the local cluster is assumed.
Aliases |
hn |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IP<IPAddress>
Specifies the IP address for the cluster port rule that will be retrieved.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<PSObject>
Specifies the cluster or cluster node for which port rules are enumerated.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-InterfaceName<String>
Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NodeName<String>
Specifies the name of the cluster node for which port rules are enumerated.
Aliases |
nn |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Port<Nullable>
Specifies a port number within the port rule to retrieve. The acceptable values for this parameter are: 0 through 65535.
Aliases |
none |
Required? |
false |
Position? |
1 |
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.NetworkLoadBalancingClusters.PowerShell.Cluster
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule
Examples
EXAMPLE 1
This example lists all the port rules on the local cluster.
PS C:\> Get-NlbClusterPortRule
EXAMPLE 2
This example gets the port rule that includes port 80.
PS C:\> Get-NlbClusterPortRule -Port 80
EXAMPLE 3
This example gets the port rule from all cluster nodes. This is especially useful if there are port rules that have Single mode.
PS C:\> Get-NlbClusterNode | Get-NlbClusterPortRule | Format-List –Property *