Edit

Get-NetworkControllerServer

  • Reference
Module:
NetworkController

Gets configuration of a physical host from the Network Controller.

Syntax

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

Description

The Get-NetworkControllerServer cmdlet gets configuration of a physical host from the Network Controller. For a host to be managed by the Network Controller, you must add it to the Network Controller by using New-NetworkControllerServer cmdlet.

Examples

Example 1: Get server configuration

PS C:\> Get-NetworkControllerServer -ConnectionUri "https://networkcontroller" -ResourceId "Server01"

This command retrieves the configuration of a server that has the resource ID Server01, from 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

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 an array of resource IDs of servers for which this cmdlet gets settings.

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

Inputs

None

Outputs

Object

This cmdlet returns an object that contains the following configuration settings:

  • Connections that specify the information that is required to connect to the server for the purposes of managing it. Each connection has a management address and a credential reference to connect to the server.
  • Model number.
  • Array of physical network interfaces on the server.
  • Operating system that runs on the server.
  • Slot in the rack that contains the server.
  • Serial number.
  • Server vendor name.
  • Virtual servers that are on the server and are being managed by Network Controller.
  • Virtual switches that are on the server and are being managed by Network Controller.