Skip to content

Commit 43e2577

Browse files
Merge pull request #14 from AnirbanPaul/patch-6
Update get-networkcontrollerippool.md
2 parents d04a7ac + f7677eb commit 43e2577

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

docset/windows/network-controller/get-networkcontrollerippool.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ ms.assetid: BDE15D73-0342-41B1-88B2-45234CF8451A
2020
# Get-NetworkControllerIpPool
2121

2222
## SYNOPSIS
23+
This cmdlet retrieves the settings of an IP pool from the Network Controller.
2324

2425
## SYNTAX
2526

@@ -30,13 +31,19 @@ Get-NetworkControllerIpPool [-NetworkId] <String[]> [-SubnetId] <String[]> [[-Re
3031
```
3132

3233
## DESCRIPTION
34+
This cmdlet retrieves the settings of an IP pool from the Network Controller. Specifically, it retrieves the start and end address of the pool, IP addresses in the pool that are being used for VIPs and the usage of IP addresses in the pool
3335

3436
## EXAMPLES
35-
37+
This example retrieves all the IP pools that are present in a subnet called Subnet1. Subnet1 is present in a network called ln1.
38+
```
39+
Get-NetworkControllerIpPool -ConnectionUri https://networkcontroller -NetworkId ln1 -SubnetId subnet1
40+
```
3641

3742
## PARAMETERS
3843

3944
### -CertificateThumbprint
45+
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.
46+
4047
```yaml
4148
Type: String
4249
Parameter Sets: (All)
@@ -50,6 +57,8 @@ Accept wildcard characters: False
5057
```
5158
5259
### -ConnectionUri
60+
Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.
61+
5362
```yaml
5463
Type: Uri
5564
Parameter Sets: (All)
@@ -63,6 +72,8 @@ Accept wildcard characters: False
6372
```
6473
6574
### -Credential
75+
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.
76+
6677
```yaml
6778
Type: PSCredential
6879
Parameter Sets: (All)
@@ -76,6 +87,7 @@ Accept wildcard characters: False
7687
```
7788
7889
### -NetworkId
90+
Specifies the network where the IP pool belongs
7991
```yaml
8092
Type: String[]
8193
Parameter Sets: (All)
@@ -102,6 +114,8 @@ Accept wildcard characters: False
102114
```
103115
104116
### -ResourceId
117+
Specifies the unique identifier for the IP pool
118+
105119
```yaml
106120
Type: String[]
107121
Parameter Sets: (All)
@@ -115,6 +129,8 @@ Accept wildcard characters: False
115129
```
116130
117131
### -SubnetId
132+
Specifies the subnet where the IP pool belongs
133+
118134
```yaml
119135
Type: String[]
120136
Parameter Sets: (All)
@@ -133,6 +149,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
133149
## INPUTS
134150
135151
## OUTPUTS
152+
Following properties are displayed by the cmdlet
153+
1. Start IP address of the pool
154+
2. End IP address of the pool
155+
3. IP addresses being used for load balancer VIPs
156+
4. Number of IP addresses in the pool that have been allocated
136157
137158
## NOTES
138159

0 commit comments

Comments
 (0)