Get-NetworkControllerLoadBalancer
This cmdlet retrieves the configuration of a load balancer resource from the Network Controller
Syntax
Default (Default)
Get-NetworkControllerLoadBalancer
[[-ResourceId] <String[]>]
-ConnectionUri <Uri>
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-PassInnerException]
[<CommonParameters>]
Description
This cmdlet retrieves the configuration of a load balancer resource. The load balancer resource allows fine-grained configuration of how incoming traffic is distributed across VM instances in a virtual network. It contains the following:
- Front End IP configuration - This describes the exposed IP address of the load balancer. For example, this address can be a reserved public or private IP address previously obtained by the customer, or an IP address dynamically allocated from a subnet of a virtual network.
- BackEnd address pools - This describes the backend VMs behind the front end IP resource.
- Load balancing rules - This defines how traffic that arrives at the front-end IP is to be sent to the backend IP
- Health probe - Health probes are used by the load balancer to determine the health state of the backend pool members.
- Inbound NAT rules - This can be used to forward external traffic to a specific VM in the virtual network
- Outbound NAT rules - This can be used to forward VM network traffic from the virtual network to external destinations using network address translation (NAT).
Examples
Example 1
This example retrieves the configuration of a load balancer resource named lb1 from the Network Controller
Get-NetworkControllerLoadBalancer -ConnectionUri https://networkcontroller -ResourceId 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.
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 |
-ConnectionUri
Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.
Parameter properties
| Type: | Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | PSCredential |
| 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 |
-PassInnerException
This cmdlet retrieves the configuration of a load balancer resource. The load balancer resource allows fine-grained configuration of how incoming traffic is distributed across VM instances in a virtual network. It contains the following:
- Front End IP configuration - This describes the exposed IP address of the load balancer. For example, this address can be a reserved public or private IP address previously obtained by the customer, or an IP address dynamically allocated from a subnet of a virtual network.
- BackEnd address pools - This describes the backend VMs behind the front end IP resource.
- Load balancing rules - This defines how traffic that arrives at the front-end IP is to be sent to the backend IP
- Health probe - Health probes are used by the load balancer to determine the health state of the backend pool members.
- Inbound NAT rules - This can be used to forward external traffic to a specific VM in the virtual network
- Outbound NAT rules - This can be used to forward VM network traffic from the virtual network to external destinations using network address translation (NAT).
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 |
-ResourceId
Specifies the unique identifier for the load balancer resource.
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 |
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
None
Outputs
Object
Following properties can be retrieved for a load balancer resource:
- Front end IP configuration
- Back end address pools
- Load balancing rules
- Inbound NAT rules
- Outbound NAT rules
- Health Probes