Edit

Share via

New-NetworkControllerNetworkInterfaceIpConfiguration

  • Reference
Module:
NetworkController

This cmdlet adds/updates an IP configuration to a network interface in the Network Controller

Syntax

New-NetworkControllerNetworkInterfaceIpConfiguration
   [-NetworkInterfaceId] <String>
   [-ResourceId] <String>
   [-Properties] <NetworkInterfaceIpConfigurationProperties>
   [[-ResourceMetadata] <ResourceMetadata>]
   [[-Etag] <String>]
   [-Force]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

This cmdlet adds/updates an IP configuration to a network interface in the Network Controller

Examples

Example 1

This example creates an IP configuration resource named IP1 for a network interface named nw1. The private IP Address is 10.0.0.1 and the IP allocation method is static.

$IpProp=New-Object Microsoft.Windows.NetworkController.NetworkInterfaceIpConfigurationPropertiesllocation
$IpProp.PrivateIpAddress="10.0.0.1"
$IpProp.PrivateIpAllocationMethod="Static"
$subnet=Get-NetworkControllerVirtualSubnet -ConnectionUri https://networkcontroller -VirtualNetworkId vnet1 -ResourceId Subnet1
$IpProp.Subnet=$subnet

New-NetworkControllerNetworkInterfaceIpconfiguration -ConnectionUri https://networkcontroller -NetworkInterfaceId nw1 -ResourceId Ip1 -Properties $IpProp

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-NetworkInterfaceId

Specifies the network interface where the IP configuration resource belongs

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

-PassInnerException

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.

The thumbprint must be provided only if the network controller client authentication is X509 certificates. Get-NetworkController retrieves that client authentication and authorization information.

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

-Properties

Following properties of a network interface can be added/updated: 1. Private IP address 2. Private IP address allocation method 3. Subnet associated with the IP configuration

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

-ResourceId

Specifies the unique identifier of the resource

Type:string
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

String

Microsoft.Windows.NetworkController.NetworkInterfaceIpConfigurationProperties

Following properties of a network interface can be added/updated: 1. Private IP address 2. Private IP address allocation method 3. Subnet associated with the IP configuration

Outputs

Object