Get-NetworkControllerLoadBalancerOutboundNatRule

Reference

Module:: NetworkController

Retrieves the outbound NAT rules associated with a load balancer resource

Syntax

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

Description

Retrieves the outbound NAT rules associated with a load balancer resource. 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 an outbound NAT rule called OutNat1 from a load balancer resource named lb1

Get-NetworkControllerLoadBalancerOutboundNatRule -ConnectionUri https://networkcontroller -LoadBalancerId lb1 -ResourceId OutNat1

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

-LoadBalancerId

Specifies the load balancer resource where the outbound NAT rule belongs.

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

-PassInnerException

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

-ResourceId

Specifies the unique identifier for the outbound NAT rule.

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

Inputs

String[]

Outputs

Object

Following properties of an outbound NAT rule can be retrieved:

Protocol
Backend address pool associated with the NAT rule
Front end IP associated with the NAT rule

Share via