From a1a50eed0c792fe696ce5d4671b38e9637d552fb Mon Sep 17 00:00:00 2001 From: Anirban Paul Date: Tue, 28 Mar 2017 11:14:17 -0700 Subject: [PATCH] Update get-networkcontrollerloadbalancingrule.md Added description and example --- .../get-networkcontrollerloadbalancingrule.md | 26 ++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/docset/windows/network-controller/get-networkcontrollerloadbalancingrule.md b/docset/windows/network-controller/get-networkcontrollerloadbalancingrule.md index 9df50537fa..e547a0a46b 100644 --- a/docset/windows/network-controller/get-networkcontrollerloadbalancingrule.md +++ b/docset/windows/network-controller/get-networkcontrollerloadbalancingrule.md @@ -20,6 +20,7 @@ ms.assetid: 14B8D7E0-560B-4BFB-ACEF-338E8BAE0FF5 # Get-NetworkControllerLoadBalancingRule ## SYNOPSIS +This cmdlet retrieves a load balancing rule associated with a load balancer. ## SYNTAX @@ -30,13 +31,19 @@ Get-NetworkControllerLoadBalancingRule [-LoadBalancerId] [[-ResourceI ``` ## DESCRIPTION +This cmdlet retrieves a load balancing rule associated with a load balancer. This load balancing rule defines how traffic that arrives at the front-end IP has to be sent to the backend IP ## EXAMPLES - +This example retrieves all the load balancing rules associated with a load balancer resource named lb1 +``` +Get-NetworkControllerLoadBalancingRule -ConnectionUri https://networkcontroller -LoadBalancerId lb1 +``` ## PARAMETERS ### -CertificateThumbprint +Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.This is the certificate thumbprint of the certificate.This thumbprint must also be provided in the *ClientCertificateThumbprint* parameter in the **Install-NetworkController** or **Set-NetworkController** cmdlet so that Network Controller can authorize this user. + ```yaml Type: String Parameter Sets: (All) @@ -50,6 +57,8 @@ Accept wildcard characters: False ``` ### -ConnectionUri +Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller. + ```yaml Type: Uri Parameter Sets: (All) @@ -63,6 +72,8 @@ Accept wildcard characters: False ``` ### -Credential +Specifies a user credential that has permission to perform this action.The default value is the current user.This user must be present in the security group provided in the *ClientSecurityGroup* parameter in the **Install-NetworkController** cmdlet. + ```yaml Type: PSCredential Parameter Sets: (All) @@ -76,6 +87,8 @@ Accept wildcard characters: False ``` ### -LoadBalancerId +Specifies the load balancer where the load balancing rule belongs. + ```yaml Type: String[] Parameter Sets: (All) @@ -102,6 +115,7 @@ Accept wildcard characters: False ``` ### -ResourceId +Specifies the unique identifier for the load balancing rule resource ```yaml Type: String[] Parameter Sets: (All) @@ -120,6 +134,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ## OUTPUTS +Following properties of a load balancing rule can be retrieved: +1. Front end IP configuration +2. Back end address pool +3. Protocol +4. Front end port +5. Health probe for the rule +6. Load distribution +7. Back End port +8. Whether floating IP is enabled +9. Idle timeout (in minutes) ## NOTES