Get-NetworkControllerLoadBalancerBackendAddressPool

Module:

NetworkController Module

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

Syntax

Default (Default)

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.

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

-LoadBalancerId

Specifies the load balancer where the backend address pool belongs

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PassInnerException

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.

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 backend address pool

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
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

String

Outputs

Object

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