Get-NetworkControllerLoadBalancerMux

This cmdlet retrieves the configuration of a load balancer VM managed by the Network Controller

Syntax

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

Description

This cmdlet retrieves the configuration of a load balancer VM managed by the Network Controller. Multiple load balancer VMs can be deployed to load balance traffic to virtual machines in the virtual network.

Examples

Example 1

This example retrieves the configuration of a load balancer MUX named Mux1 from the Network Controller

Get-NetworkControllerLoadBalancerMux -ConnectionUri https://networkcontroller -ResourceId Mux1

Required Parameters

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

Optional 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
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassInnerException
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Specifies the unique identifier for the resource

Type:String[]
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Following properties can be retrieved for a load balancer MUX:

  1. Router configuration - This includes local ASN of the MUX router and peer router configuration (Name, local IP address, peer IP address, Peer ASN)
  2. Certificate of the MUX
  3. An array of connections that specifies the information needed to connect to the MUX for the purposes of managing and controlling the device.
  4. Virtual server associated with the MUX resource