Edit

Share via

Get-NetworkControllerServerInterface

  • Reference
Module:
NetworkController

Gets settings of physical network interfaces from the Network Controller.

Syntax

Get-NetworkControllerServerInterface
   [-ServerId] <String[]>
   [[-ResourceId] <String[]>]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [<CommonParameters>]

Description

The Get-NetworkControllerServerInterface cmdlet gets settings of physical network interfaces from the Network Controller.

Examples

Example 1: Get settings of a network interface

PS C:\> Get-NetworkControllerServerInterface -ConnectionUri "https://networkcontroller" -ServerId "Server01" -ResourceId "Interface01"

This command retrieves settings of a network interface that has the resource ID Interface01. The interface is on a server that has the resource ID Server01. The URI identifies the Network Controller.

Parameters

-CertificateThumbprint

Specifies the certificate thumbprint of a digital public key X.509 certificate of a user account that has permission to perform this action. In order for Network Controller to authorize the account, specify this thumbprint by using the ClientCertificateThumbprint parameter of the Install-NetworkController or Set-NetworkController cmdlet.

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. All Representational State Transfer (REST) clients use this URI 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 specified in the ClientSecurityGroup parameter in Install-NetworkController.

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

-PassInnerException

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

-ResourceId

Specifies an array of resource IDs of server interfaces for which this cmdlet gets settings.

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

-ServerId

Specifies the server from which this cmdlet gets settings for an interface.

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

Outputs

This cmdlet returns an object that contains the following properties:

  • Administrative status of the interface. Valid values are Up and Down.
  • Interface index.
  • Interface name.
  • Interface speed.
  • IP configuration of the interface. This property contains IP address, network prefix, default gateway, VLANs, and whether the IP has been obtained over DHCP.
  • Logical subnets to which the network interface is connected.
  • MAC address.
  • Operational status of the interface.
  • VLAN IDs of networks to which the interface is connected.
  • Whether this interface is a baseboard management controller (BMC) interface.