Skip to content

Commit e2ec1d4

Browse files
author
anavinahar
committed
LB smdlet help
1 parent ad90654 commit e2ec1d4

File tree

1 file changed

+159
-88
lines changed

1 file changed

+159
-88
lines changed

‎src/ResourceManager/Network/Commands.Network/Microsoft.Azure.Commands.Network.dll-Help.xml

Lines changed: 159 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,8 @@
403403
<maml:description/>
404404
</dev:type>
405405
<maml:description>
406-
<maml:para>System.String</maml:para>
406+
<maml:para>
407+
System.String</maml:para>
407408
</maml:description>
408409
</command:inputType>
409410
</command:inputTypes>
@@ -5170,12 +5171,47 @@ PS C:\&gt; Get-AzureRmLoadBalancer -Name &quot;myLB&quot; -ResourceGroupName &qu
51705171
<maml:introduction>
51715172
<maml:paragraph>PS C:\&gt;</maml:paragraph>
51725173
</maml:introduction>
5173-
<dev:code></dev:code>
5174+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
5175+
5176+
PS C:\&gt; $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;NewNatRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
5177+
</dev:code>
51745178
<dev:remarks>
5179+
<maml:para>The first command stores the existing load balancer called &quot;MyloadBalancer&quot; into a varibale called $slb. The second command then adds an Inbound NAT rule configuration with appropriate details. Note that these are chosen as an example and these may change based on one&#39;s loadbalancer.</maml:para>
51755180
<maml:para />
51765181
<maml:para />
5177-
<maml:para />
5178-
<maml:para></maml:para>
5182+
<maml:para>Name : MyLoadBalancer
5183+
ResourceGroupName : MyResourceGroup
5184+
Location : westus
5185+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer
5186+
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
5187+
ResourceGuid : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
5188+
ProvisioningState : Succeeded
5189+
Tags :
5190+
FrontendIpConfigurations : []
5191+
BackendAddressPools : []
5192+
LoadBalancingRules : []
5193+
Probes : []
5194+
InboundNatRules : [
5195+
5196+
{
5197+
&quot;Name&quot;: &quot;NewNatRule&quot;,
5198+
&quot;Etag&quot;: &quot;W/\&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\&quot;&quot;,
5199+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/inbo
5200+
undNatRules/NewRule&quot;,
5201+
&quot;FrontendPort&quot;: 81,
5202+
&quot;IdleTimeoutInMinutes&quot;: 4,
5203+
&quot;EnableFloatingIP&quot;: true,
5204+
&quot;FrontendIPConfiguration&quot;: {
5205+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/fr
5206+
ontendIPConfigurations/MyFrontEnd&quot;
5207+
},
5208+
&quot;BackendPort&quot;: 8181,
5209+
&quot;Protocol&quot;: &quot;Tcp&quot;,
5210+
&quot;ProvisioningState&quot;: &quot;Succeeded&quot;
5211+
}
5212+
]
5213+
InboundNatPools : []
5214+
</maml:para>
51795215
</dev:remarks>
51805216
<command:commandLines>
51815217
<command:commandLine>
@@ -5952,12 +5988,43 @@ PS C:\&gt; Get-AzureRmLoadBalancer -Name &quot;myLB&quot; -ResourceGroupName &qu
59525988
<maml:introduction>
59535989
<maml:paragraph>PS C:\&gt;</maml:paragraph>
59545990
</maml:introduction>
5955-
<dev:code></dev:code>
5991+
<dev:code>
5992+
PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
5993+
5994+
PS C:\&gt; $slb | Add-AzureRmLoadBalancerRuleConfig -Name &quot;NewRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
5995+
</dev:code>
59565996
<dev:remarks>
5997+
<maml:para>The first command stores the existing load balancer called &quot;MyLoadBalancer&quot; in variable $slb. The second command then adds the rule called &quot;NewRule&quot; with certain specifications.</maml:para>
5998+
<maml:para>Below is what sample output looks like for this specific scenario:</maml:para>
59575999
<maml:para />
59586000
<maml:para />
5959-
<maml:para />
5960-
<maml:para></maml:para>
6001+
<maml:para>Name : MyLoadBalancer
6002+
ResourceGroupName : MyResourceGroup
6003+
Location : westus
6004+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer
6005+
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
6006+
ResourceGuid : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
6007+
ProvisioningState : Succeeded
6008+
Tags :
6009+
FrontendIpConfigurations : []
6010+
BackendAddressPools : []
6011+
LoadBalancingRules : [
6012+
&quot;Name&quot;: &quot;NewRule&quot;,
6013+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/inbo
6014+
undNatRules/NewRule&quot;,
6015+
&quot;FrontendPort&quot;: 3350,
6016+
&quot;EnableFloatingIP&quot;: true,
6017+
&quot;FrontendIPConfiguration&quot;: {
6018+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/fr
6019+
ontendIPConfigurations/MyFrontEnd&quot;
6020+
},
6021+
&quot;BackendPort&quot;: 3350,
6022+
&quot;Protocol&quot;: &quot;Tcp&quot;
6023+
}
6024+
]
6025+
Probes : []
6026+
InboundNatRules : []
6027+
</maml:para>
59616028
</dev:remarks>
59626029
<command:commandLines>
59636030
<command:commandLine>
@@ -13591,36 +13658,12 @@ InboundNatPools : []</maml:para>
1359113658
</maml:introduction>
1359213659
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name MyLoadBalancer -ResourceGroupName MyResourceGroup
1359313660

13594-
PS C:\&gt; Get-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;MyinboundNatRule1&quot; -LoadBalancer $slb
13595-
</dev:code>
13661+
PS C:\&gt; Get-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;MyinboundNatRule1&quot; -LoadBalancer $slb</dev:code>
1359613662
<dev:remarks>
1359713663
<maml:para>The first command gets the existing load balancer for which the inbound NAT rule is wanted and stores it in the variable slb. The second command then gets the accodiated NAT rule called MyinboundNatRule1.</maml:para>
13598-
<maml:para>Below is the sample output:</maml:para>
1359913664
<maml:para />
1360013665
<maml:para />
13601-
<maml:para>Name : MyinboundNatRule1
13602-
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/
13603-
providers/Microsoft.Network/loadBalancers/MyLoadBalancer/inboundNatRules/Myinbound
13604-
NatRule1
13605-
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
13606-
ProvisioningState : Succeeded
13607-
Protocol : Tcp
13608-
FrontendPort : 3389
13609-
BackendPort : 3389
13610-
IdleTimeoutInMinutes : 15
13611-
EnableFloatingIP : True
13612-
FrontendIPConfiguration : {
13613-
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/
13614-
MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/frontendIPConfig
13615-
urations/MyFrontEnd&quot;
13616-
}
13617-
BackendIPConfiguration : {
13618-
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/
13619-
MyResourceGroup/providers/Microsoft.Network/networkInterfaces/lb-nic1-be/ipConfigur
13620-
ations/ipconfig1&quot;,
13621-
&quot;Primary&quot;: false
13622-
}
13623-
</maml:para>
13666+
<maml:para></maml:para>
1362413667
</dev:remarks>
1362513668
<command:commandLines>
1362613669
<command:commandLine>
@@ -13804,32 +13847,12 @@ BackendIPConfiguration : {
1380413847
</maml:introduction>
1380513848
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
1380613849

13807-
PS C:\&gt; Get-AzureRmLoadBalancerProbeConfig -Name &quot;MyProbe&quot; -LoadBalancer $slb
13808-
</dev:code>
13850+
PS C:\&gt; Get-AzureRmLoadBalancerProbeConfig -Name &quot;MyProbe&quot; -LoadBalancer $slb</dev:code>
1380913851
<dev:remarks>
1381013852
<maml:para>The first command gets the load balancer called &quot;MyLoadBalancer&quot; and stores it in the variable $slb. The second command then gets the associated probe configuration called MyProbe.</maml:para>
13811-
<maml:para>
13812-
Below is sample output:</maml:para>
1381313853
<maml:para />
1381413854
<maml:para />
13815-
<maml:para>
13816-
Name : MyProbe
13817-
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/provi
13818-
ders/Microsoft.Network/loadBalancers/MyLoadBalancer/probes/MyProbe
13819-
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
13820-
ProvisioningState : Succeeded
13821-
Protocol : Http
13822-
Port : 80
13823-
IntervalInSeconds : 15
13824-
NumberOfProbes : 2
13825-
RequestPath : healthcheck.aspx
13826-
LoadBalancingRules : [
13827-
{
13828-
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup
13829-
/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/loadBalancingRules/MyLBr
13830-
uleName&quot;
13831-
}
13832-
]</maml:para>
13855+
<maml:para></maml:para>
1383313856
</dev:remarks>
1383413857
<command:commandLines>
1383513858
<command:commandLine>
@@ -14013,35 +14036,12 @@ LoadBalancingRules : [
1401314036
</maml:introduction>
1401414037
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name MyLoadBalancer -ResourceGroupName MyResourceGroup
1401514038

14016-
PS C:\&gt; Get-AzureRmLoadBalancerRuleConfig -Name &quot;MyLBrulename&quot; -LoadBalancer $slb
14017-
</dev:code>
14039+
PS C:\&gt; Get-AzureRmLoadBalancerRuleConfig -Name &quot;MyLBrulename&quot; -LoadBalancer $slb</dev:code>
1401814040
<dev:remarks>
1401914041
<maml:para>The first command gets the load balancer and stores it in the variable $slb. The second command gets the associated rule configuration called MyLBrulename.</maml:para>
14020-
<maml:para>Below is sample output:</maml:para>
1402114042
<maml:para />
1402214043
<maml:para />
14023-
<maml:para>Name : MyLBruleName
14024-
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/provi
14025-
ders/Microsoft.Network/loadBalancers/MyLoadBalancer/probes/MyLBrulename
14026-
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
14027-
ProvisioningState : Succeeded
14028-
Protocol : Tcp
14029-
FrontendPort : 80
14030-
BackendPort : 80
14031-
IdleTimeoutInMinutes : 15
14032-
v : SourceIP
14033-
EnableFloatingIP : True
14034-
FrontendIPConfiguration : {
14035-
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup
14036-
/providers/Microsoft.Network/loadBalancers/MyLoadBalancer//frontendIPConfig
14037-
urations/MyFrontEnd&quot;
14038-
}
14039-
BackendAddressPool :
14040-
Probe : {
14041-
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup
14042-
/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/probes/MyProbe&quot;
14043-
14044-
}</maml:para>
14044+
<maml:para></maml:para>
1404514045
</dev:remarks>
1404614046
<command:commandLines>
1404714047
<command:commandLine>
@@ -45249,16 +45249,52 @@ PS C:\&gt; $slb | Set-AzureRmLoadBalancerFrontendIpConfig -Name &quot;NewFronten
4524945249
</maml:alertSet>
4525045250
<command:examples>
4525145251
<command:example>
45252-
<maml:title>-------------------------- 1: --------------------------</maml:title>
45252+
<maml:title>-------------------------- Example 1 Updating the inbound NAT rule configuration on an existing load balancer --------------------------</maml:title>
4525345253
<maml:introduction>
4525445254
<maml:paragraph>PS C:\&gt;</maml:paragraph>
4525545255
</maml:introduction>
45256-
<dev:code></dev:code>
45256+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
45257+
45258+
PS C:\&gt; $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;NewNatRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
45259+
45260+
PS C:\&gt; $slb | Set-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;NewNatRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 </dev:code>
4525745261
<dev:remarks>
45262+
<maml:para>The first command stores the existing load balancer called &quot;MyloadBalancer&quot; into a varibale called $slb. The second command then adds an Inbound NAT rule configuration with certain properties. One of these is enablibling floating IP. However once added, lets assume one no longer wants this properly enabled, then the third command is used to update this for the load balancer using the Set-AzureRmLoadBalancerInboundNatRuleConfig.</maml:para>
45263+
<maml:para>Notice how the output below has -EnablePloatingIP to false even though when NewNatRule was added it was set to true. Similarly, other properties can be changed using this cmdlet.</maml:para>
4525845264
<maml:para />
4525945265
<maml:para />
45260-
<maml:para />
45261-
<maml:para></maml:para>
45266+
<maml:para>Name : MyLoadBalancer
45267+
ResourceGroupName : MyResourceGroup
45268+
Location : westus
45269+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer
45270+
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
45271+
ResourceGuid : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
45272+
ProvisioningState : Succeeded
45273+
Tags :
45274+
FrontendIpConfigurations : []
45275+
BackendAddressPools : []
45276+
LoadBalancingRules : []
45277+
Probes : []
45278+
InboundNatRules : [
45279+
45280+
{
45281+
&quot;Name&quot;: &quot;NewNatRule&quot;,
45282+
&quot;Etag&quot;: &quot;W/\&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\&quot;&quot;,
45283+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/inbo
45284+
undNatRules/NewRule&quot;,
45285+
&quot;FrontendPort&quot;: 81,
45286+
&quot;IdleTimeoutInMinutes&quot;: 4,
45287+
&quot;EnableFloatingIP&quot;: false,
45288+
&quot;FrontendIPConfiguration&quot;: {
45289+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/fr
45290+
ontendIPConfigurations/MyFrontEnd&quot;
45291+
},
45292+
&quot;BackendPort&quot;: 8181,
45293+
&quot;Protocol&quot;: &quot;Tcp&quot;,
45294+
&quot;ProvisioningState&quot;: &quot;Succeeded&quot;
45295+
}
45296+
]
45297+
InboundNatPools : []</maml:para>
4526245298
</dev:remarks>
4526345299
<command:commandLines>
4526445300
<command:commandLine>
@@ -46023,16 +46059,51 @@ PS C:\&gt; $slb | Set-AzureRmLoadBalancerProbeConfig -Name &quot;NewProbe&quot;
4602346059
</maml:alertSet>
4602446060
<command:examples>
4602546061
<command:example>
46026-
<maml:title>-------------------------- 1: --------------------------</maml:title>
46062+
<maml:title>-------------------------- Example 1 Updating a load balancing rule on an existing load balancer --------------------------</maml:title>
4602746063
<maml:introduction>
4602846064
<maml:paragraph>PS C:\&gt;</maml:paragraph>
4602946065
</maml:introduction>
46030-
<dev:code></dev:code>
46066+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
46067+
46068+
PS C:\&gt; $slb | $slb | Add-AzureRmLoadBalancerRuleConfig -Name &quot;NewRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
46069+
46070+
46071+
PS C:\&gt; $slb | Set-AzureRmLoadBalancerRuleConfig -Name &quot;NewRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350
46072+
46073+
46074+
</dev:code>
4603146075
<dev:remarks>
46076+
<maml:para>The first command stores an existing load balancer called MyLoadBalancer in the variable $slb. The second command adds a load balancing rule called NewRule with certain specifications. One of these is enabling floating IP to be true. However once added, lets assume one no longer wants this properly enabled, then the third command is used to update this for the load balancer using the Set-AzureRmLoadBalancerRuleConfig.</maml:para>
46077+
<maml:para>Notice how the output below has -EnablePloatingIP to false even though when NewRule was added it was set to true. Similarly, other properties can be changed using this cmdlet.
46078+
</maml:para>
4603246079
<maml:para />
4603346080
<maml:para />
46034-
<maml:para />
46035-
<maml:para></maml:para>
46081+
<maml:para>Name : MyLoadBalancer
46082+
ResourceGroupName : MyResourceGroup
46083+
Location : westus
46084+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer
46085+
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
46086+
ResourceGuid : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
46087+
ProvisioningState : Succeeded
46088+
Tags :
46089+
FrontendIpConfigurations : []
46090+
BackendAddressPools : []
46091+
LoadBalancingRules : [
46092+
&quot;Name&quot;: &quot;NewRule&quot;,
46093+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/inbo
46094+
undNatRules/NewRule&quot;,
46095+
&quot;FrontendPort&quot;: 3350,
46096+
&quot;EnableFloatingIP&quot;: false,
46097+
&quot;FrontendIPConfiguration&quot;: {
46098+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/fr
46099+
ontendIPConfigurations/MyFrontEnd&quot;
46100+
},
46101+
&quot;BackendPort&quot;: 3350,
46102+
&quot;Protocol&quot;: &quot;Tcp&quot;
46103+
}
46104+
]
46105+
Probes : []
46106+
InboundNatRules : []</maml:para>
4603646107
</dev:remarks>
4603746108
<command:commandLines>
4603846109
<command:commandLine>

0 commit comments

Comments
 (0)