Get-HpcNetworkInterface
Gets network interfaces on the head node.
Syntax
Get-HpcNetworkInterface
[[-Type] <String[]>]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>] Get-HpcNetworkInterface
[-Name <String[]>]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>] 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.
Examples
Example 1: Get all network interfaces
PS C:\>Get-HpcNetworkInteraceThis command gets all of the network interfaces on the head node of the HPC cluster.
Example 2: Get network interfaces by type
PS C:\>Get-HpcNetworkInterface -Type "Enterprise,Private"This command gets all of the network interfaces on the head node that have a type of Enterprise or Private.
Parameters
-ClusterConnectionString
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.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies an array of names for the network interfaces that you want to get. You cannot specify both the Name and Type parameters.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Scheduler
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\>
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Type
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.
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
HpcNetworkBinding[]
Notes
- You must be a cluster administrator to run this cmdlet successfully.