Skip to content

Update get-networkcontrollerippool.md #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 28, 2017
Merged

Update get-networkcontrollerippool.md #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docset/windows/network-controller/get-networkcontrollerippool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ ms.assetid: BDE15D73-0342-41B1-88B2-45234CF8451A
# Get-NetworkControllerIpPool

## SYNOPSIS
This cmdlet retrieves the settings of an IP pool from the Network Controller.

## SYNTAX

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

## DESCRIPTION
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

## EXAMPLES

This example retrieves all the IP pools that are present in a subnet called Subnet1. Subnet1 is present in a network called ln1.
```
Get-NetworkControllerIpPool -ConnectionUri https://networkcontroller -NetworkId ln1 -SubnetId subnet1
```

## 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.

```yaml
Type: String
Parameter Sets: (All)
Expand All @@ -50,6 +57,8 @@ 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.

```yaml
Type: Uri
Parameter Sets: (All)
Expand All @@ -63,6 +72,8 @@ 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.

```yaml
Type: PSCredential
Parameter Sets: (All)
Expand All @@ -76,6 +87,7 @@ Accept wildcard characters: False
```

### -NetworkId
Specifies the network where the IP pool belongs
```yaml
Type: String[]
Parameter Sets: (All)
Expand All @@ -102,6 +114,8 @@ Accept wildcard characters: False
```

### -ResourceId
Specifies the unique identifier for the IP pool

```yaml
Type: String[]
Parameter Sets: (All)
Expand All @@ -115,6 +129,8 @@ Accept wildcard characters: False
```

### -SubnetId
Specifies the subnet where the IP pool belongs

```yaml
Type: String[]
Parameter Sets: (All)
Expand All @@ -133,6 +149,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

## OUTPUTS
Following properties are displayed by the cmdlet
1. Start IP address of the pool
2. End IP address of the pool
3. IP addresses being used for load balancer VIPs
4. Number of IP addresses in the pool that have been allocated

## NOTES

Expand Down