New-NetworkControllerIpPool

Reference

Module:: NetworkController

This cmdlet adds a new IP address pool to an existing subnet in an existing network

Syntax

PowerShell

New-NetworkControllerIpPool
   -ConnectionUri <Uri>
   -NetworkId <string>
   -Properties <IpPoolProperties>
   -ResourceId <string>
   -SubnetId <string>
   [-CertificateThumbPrint <string>]
   [-Credential <PSCredential>]
   [-Etag <string>]
   [-Force]
   [-ResourceMetadata <ResourceMetadata>]

Description

This cmdlet adds a new IP address pool to an existing subnet in an existing network. The IP address pool must not conflict with any other IP address pool on the network.

Examples

Example 1

This example creates an IP pool with start IP address of 10.0.0.5 and end IP address of 10.0.0.15. This IP pool is created in a subnet called subnet1. Subnet1 is part of a network called ln1.

PowerShell

$poolProperties=New-Object Microsoft.Windows.NetworkController.IpPoolProperties
$poolProperties.startIPAddress = "10.0.0.5"
$poolProperties.endIPAddress = "10.0.0.15"
New-NetworkControllerIpPool -ConnectionUri https://networkcontroller -ResourceId ln1pool1 -NetworkId ln1 -SubnetId subnet1 -Properties $poolProperties

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

-Etag

Specifies the entity tag (ETag) parameter of the resource. An ETag (entity tag) is an HTTP response header returned by an HTTP-compliant web server used to determine change in the content of a resource at a given URL. The value of the header is an opaque string representing the state of the resource at the time the response was generated.

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

-Force

Forces the command to run without asking for user confirmation.

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

-NetworkId

Network resource ID for which IP pool is being created

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

-Properties

Identifies the properties of the IP pool. This includes the start IP address, the end IP address, and the IP addresses reserved for load balancer VIPs.

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

-ResourceId

Specifies the ID of the IP pool

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

-ResourceMetadata

This parameter contains metadata information for the client, such as the tenant ID, group ID, and resource name.

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

-SubnetId

Network subnet resource ID for which IP pool is being created

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

Inputs

The following properties are provided for each IP pool

Start IP address
End IP address
IP addresses reserved for load balancer VIPs

Share via