Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Get-HpcNetworkInterface

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

Syntax

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

Get-HpcNetworkInterface [-Scheduler <string>] [[-Type] <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.

 

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

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>

 

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.

 

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.

Input and Return Types

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

 

Input Type

None.

Return Type

One or more HpcNetworkBinding objects.

Example 1

C:\PS>Get-HpcNetworkInterace

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

Example 2

C:\PS>Get-HpcNetworkInterface -Type Enterprise,Private

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

See Also

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.