Edit

Get-NetworkControllerNetworkInterfaceIpConfiguration

  • Reference
Module:
NetworkController

This cmdlet retrieves the IP configuration of a network interface from the Network Controller

Syntax

Get-NetworkControllerNetworkInterfaceIpConfiguration
   [-NetworkInterfaceId] <String[]>
   [[-ResourceId] <String[]>]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [<CommonParameters>]

Description

This cmdlet retrieves the IP configuration of a network interface from the Network Controller

Examples

Example 1

This example retrieves the all the IP configurations of a network interface named nw1, from the Network Controller

Get-NetworkControllerNetworkInterfaceIpConfiguration -ConnectionUri https://networkcontroller -NetworkInterfaceId nw1

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

-NetworkInterfaceId

Specifies the network interface where the IP configuration belongs

Type:String[]
Position:0
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

-ResourceId

Specifies the unique identifier for the resource

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String[]

Outputs

Object

Following properties can be retrieved from an IP interface IP Configuration resource:

  1. Private IP address
  2. Private IP address allocation method
  3. Load balancer backend address pools associated with the IP configuration
  4. Load balancer inbound NAT Rules associated with the IP configuration
  5. Subnet associated with the IP configuration
  6. Public IP address associated with the IP configuration
  7. Access control list associated with the IP Configuration
  8. Service insertion rules associated with the IP configuration