Get-HpcNetworkInterface

Get-HpcNetworkInterface

Gets network interfaces on the head node.

Syntax

Parameter Set: Type
Get-HpcNetworkInterface [[-Type] {Enterprise | Private | Application}[] ] [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [ <CommonParameters>]

Parameter Set: Name
Get-HpcNetworkInterface [-ClusterConnectionString <String[]> ] [-Name <String[]> ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

The Get-HpcNetworkInterface cmdlet 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

-ClusterConnectionString<String[]>

Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers. The value format is host1,host2,host3. If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies. To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING <head_node_name>.

This parameter was introduced in HPC Pack 2016.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of 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

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Type<String[]>

Specifies an array of types for the network interfaces that you want to get. Valid types are:

-- Enterprise
-- Private
-- Application

You cannot specify both the Type and Name parameters.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. 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.

  • HpcNetworkBinding[]

Notes

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

Examples

Example 1: Get all network interfaces

This command gets all of the network interfaces on the head node of the HPC cluster.


PS C:\> Get-HpcNetworkInterace

Example 2: Get network interfaces by type

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


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

Related topics

Community Additions

ADD
Show: