Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-NetworkControllerLoadBalancerBackendAddressPool

Last Updated: 4/18/2017

SYNOPSIS

This cmdlet retrieves the back end address pool configuration associated with a load balancer.

SYNTAX

Get-NetworkControllerLoadBalancerBackendAddressPool [-LoadBalancerId] <String[]> [[-ResourceId] <String[]>]
 -ConnectionUri <Uri> [-CertificateThumbprint <String>] [-Credential <PSCredential>] [-PassInnerException]
 [<CommonParameters>]

DESCRIPTION

This cmdlet retrieves the back end address pool configuration associated with a load balancer. The backend address pool contains the Dynamic IPs (DIPs) that make up the members of the load balanced set of VMs.

EXAMPLES

Example 1

This example retrieves all the backend address pool resources from a load balancer resource named lb1

Get-NetworkControllerLoadBalancerBackendAddressPool -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.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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.

Type: Uri
Parameter Sets: (All)
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
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.

Type: PSCredential
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoadBalancerId

Specifies the load balancer where the backend address pool belongs

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PassInnerException

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceId

Specifies the unique identifier for the backend address pool

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Following properties can be retrieved for a backend address pool:

  1. Backend IP configurations of the members of the pool
  2. Outbound NAT rules associated with the backend address pool
  3. Load balancing rules associated with the backend address pool ## NOTES
© 2017 Microsoft