Get-HpcNetworkInterface

Gets the network interfaces on the head node that have one or more specified names or one or more specified types.

Syntax

	Copy Code
Parameter Set: Name Get-HpcNetworkInterface [-Name <String[]> ] [-Scheduler <String> ] [ <CommonParameters>] Parameter Set: Type Get-HpcNetworkInterface [[-Type] <String[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Copy Code

Parameter Set: Name


Get-HpcNetworkInterface [-Name <String[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Parameter Set: Type


Get-HpcNetworkInterface [[-Type] <String[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Gets the network interfaces on the head node that have one or more specified names or one or more specified types. If you do not specify any names or types, the Get-HpcNetworkInterface cmdlet gets all of the network interfaces on the head node.

Parameters

-Name<String[]>

Specifies a list of one or more names for the network interfaces that you want to get. You cannot specify both the Name and Type parameters.

Aliases	none
Required?	false
Position?	named
Default Value	no default
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	true

-Scheduler<String>

Specifies the host name or IP address of the head node for the cluster. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:

Set-Content Env:CCP_SCHEDULER <head_node_name>

Aliases	none
Required?	false
Position?	named
Default Value	%CCP_SCHEDULER%
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Type<String[]>

Specifies a list of one or more types for the network interfaces that you want to get. The valid types are Enterprise, Private, and Application. You cannot specify both the Type and Name parameters.

Aliases	none
Required?	false
Position?	1
Default Value	Enterprise,Private,Application
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

None.

Outputs

The output type is the type of the objects that the cmdlet emits.

One or more HpcNetworkBinding objects.

Notes

You must be a cluster administrator to run this cmdlet successfully.

Examples

EXAMPLE 1

Gets all of the network interfaces on the head node of the HPC cluster.

	Copy Code
Get-HpcNetworkInterace

EXAMPLE 2

Gets all of the network interfaces on the head node that have a type of Enterprise or Private.

	Copy Code
Get-HpcNetworkInterface -Type Enterprise,Private