Set-HpcNetwork
Syntax
 Copy Code |
|
|---|---|
Parameter Set: Default
Set-HpcNetwork [[-Topology] <String> ] [-Application <String> ] [-ApplicationDHCP <Boolean> ] [-ApplicationDHCPClient] [-ApplicationDHCPDns <String> ] [-ApplicationDHCPEndAddress <String> ] [-ApplicationDHCPGateway <String> ] [-ApplicationDHCPStartAddress <String> ] [-ApplicationDnsRegistrationType {<FullDnsNameOnly> | <None> | <WithConnectionDnsSuffix>} ] [-ApplicationFirewall <Nullable`1> ] [-ApplicationIpAddress <String> ] [-ApplicationNat <Boolean> ] [-ApplicationSubnetMask <String> ] [-Enterprise <String> ] [-EnterpriseDnsRegistrationType {<FullDnsNameOnly> | <None> | <WithConnectionDnsSuffix>} ] [-EnterpriseFirewall <Nullable`1> ] [-Private <String> ] [-PrivateDHCP <Boolean> ] [-PrivateDHCPClient] [-PrivateDHCPDns <String> ] [-PrivateDHCPEndAddress <String> ] [-PrivateDHCPGateway <String> ] [-PrivateDHCPStartAddress <String> ] [-PrivateDnsRegistrationType {<FullDnsNameOnly> | <None> | <WithConnectionDnsSuffix>} ] [-PrivateFirewall <Nullable`1> ] [-PrivateIpAddress <String> ] [-PrivateNat <Boolean> ] [-PrivateSubnetMask <String> ] [-Scheduler <String> ] [ <CommonParameters>]
|
|
Detailed Description
Sets the network topology and the properties of all of the network interfaces for the HPC cluster. Five network topologies are available: Enterprise, Private, EnterprisePrivate, PrivateApplication, EnterprisePrivateApplication. You can set the properties for three types of network interfaces: Enterprise, Private, and Application. You can set different properties depending on the type of the network interface.
Parameters
-Application<String>
Specifies the name of the network interface to use for the Application network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
true |
-ApplicationDHCP<Boolean>
Specifies whether Dynamic Host Configuration Protocol (DHCP) services are turned on for the Application network. A non-zero or $true value turns on DHCP services, A value of 0 or $false turns off DHCP services.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ApplicationDHCPClient
Causes the network adapter for the Application network to retrieve its IP address settings from a Dynamic Host Configuration Protocol (DHCP) server on the Application network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
not applicable |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ApplicationDHCPDns<String>
Specifies the IP address of the Domain Name System (DNS) server that Dynamic Host Configuration Protocol (DHCP) uses on the Application network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ApplicationDHCPEndAddress<String>
Specifies the ending IP address for the Dynamic Host Configuration Protocol (DHCP) scope for the Application network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ApplicationDHCPGateway<String>
Specifies the IP address of the Dynamic Host Configuration Protocol (DHCP) gateway for the Application network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ApplicationDHCPStartAddress<String>
Specifies the starting IP address for the Dynamic Host Configuration Protocol (DHCP) scope for the Application network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ApplicationDnsRegistrationType<HpcDnsRegistrationType>
Specifies the Domain Name System (DNS) registration type for the Application network.
The acceptable values for this parameter are:
|
FullDnsNameOnly |
The network connection is configured to use a DNS dynamic update to register the primary DNS suffix appended to the computer name. |
|
None |
The network connection is configured to not use a DNS dynamic update for all names on the computer. |
|
WithConnectionDnsSuffix |
The network connection is configured to use a DNS dynamic update to register the connection-specific DNS suffix appended to the computer name. |
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
None |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ApplicationFirewall<Nullable`1>
Specifies whether to turn on the firewall for the Application network on all nodes in the HPC cluster. A non-zero or $true value turns on the firewall for the Application network on all nodes in the HPC cluster. A value of 0 or $false turns off the firewall for the Application network on all nodes in the cluster. A $null value maintains the current firewall settings for the Application network across the HPC cluster.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ApplicationIpAddress<String>
Specifies the IP address of the network interface for the head node on the Application network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ApplicationNat<Boolean>
Specifies whether to turn on network address translation (NAT) on the Application network. A non-zero or $true value turns on NAT. A value of 0 or $false turns off NAT.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ApplicationSubnetMask<String>
Specifies the subnet mask to use for the Application network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Enterprise<String>
Specifies the name of the network interface to use for the Enterprise network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
true |
-EnterpriseDnsRegistrationType<HpcDnsRegistrationType>
Specifies the Domain Name System (DNS) registration type for the Enterprise network.
The acceptable values for this parameter are:
|
FullDnsNameOnly |
The network connection is configured to use a DNS dynamic update to register the primary DNS suffix appended to the computer name. |
|
None |
The network connection is configured to not use a DNS dynamic update for all names on the computer. |
|
WithConnectionDnsSuffix |
The network connection is configured to use a DNS dynamic update to register the connection-specific DNS suffix appended to the computer name. |
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
FullDnsNameOnly |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-EnterpriseFirewall<Nullable`1>
Specifies whether to turn on the firewall for the Enterprise network on all nodes in the HPC cluster. A non-zero or $true value turns on the firewall for the Enterprise network on all nodes in the HPC cluster. A value of 0 or $false turns off the firewall for the Enterprise network on all nodes in the cluster. A $null value maintains the current firewall settings for the Enterprise across the HPC cluster.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Private<String>
Specifies the name of the network interface to user for the Private network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
true |
-PrivateDHCP<Boolean>
Specifies whether Dynamic Host Configuration Protocol (DHCP) services are turned on for the Private network. A non-zero or $true value turns on DHCP services, A value of 0 or $false turns off DHCP services.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-PrivateDHCPClient
Causes the network adapter for the Private network to retrieve its IP address settings from a Dynamic Host Configuration Protocol (DHCP) server on the Private network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
not applicable |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-PrivateDHCPDns<String>
Specifies the IP address of the Domain Name System (DNS) server that Dynamic Host Configuration Protocol (DHCP) uses on the Private network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-PrivateDHCPEndAddress<String>
Specifies the ending IP address for the Dynamic Host Configuration Protocol (DHCP) scope for the Private network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-PrivateDHCPGateway<String>
Specifies the IP address of the Dynamic Host Configuration Protocol (DHCP) gateway for the Private network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-PrivateDHCPStartAddress<String>
Specifies the starting IP address for the Dynamic Host Configuration Protocol (DHCP) scope for the Private network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-PrivateDnsRegistrationType<HpcDnsRegistrationType>
Specifies the Domain Name System (DNS) registration type for the Private network.
The acceptable values for this parameter are:
|
FullDnsNameOnly |
The network connection is configured to use a DNS dynamic update to register the primary DNS suffix appended to the computer name. |
|
None |
The network connection is configured to not use a DNS dynamic update for all names on the computer. |
|
WithConnectionDnsSuffix |
The network connection is configured to use a DNS dynamic update to register the connection-specific DNS suffix appended to the computer name. |
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
None |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-PrivateFirewall<Nullable`1>
Specifies whether to turn on the firewall for the Private network on all nodes in the HPC cluster. A non-zero or $true value turns on the firewall for the Private network on all nodes in the HPC cluster. A value of 0 or $false turns off the firewall for the Private network on all nodes in the cluster. A $null value maintains the current firewall settings for the Private network across the HPC cluster.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-PrivateIpAddress<String>
Specifies the IP address of the network interface for the head node on the Private network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-PrivateNat<Boolean>
Specifies whether to turn on NAT on the Private network. A non-zero or $true value turns on NAT. A value of 0 or $false turns off NAT.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-PrivateSubnetMask<String>
Specifies the subnet mask to use for the Private network.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
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 |
%CCP_SCHEDULER% |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Topology<String>
Specifies the network topology to set for the HPC cluster. The network topology can be Enterprise, Private, EnterprisePrivate, PrivateApplication, or EnterprisePrivateApplication. These topologies are defined as follows:
Enterprise: All nodes are connected only to an enterprise network. You only need one network adapter on the head node for this topology.
Private: The compute nodes are isolated on a private network. You need two network adapters on the head node for this topology.
EnterprisePrivate: All nodes are connected to both enterprise and private networks. You need two network adapters on the head node for this topology.
PrivateApplication: The compute nodes are isolated on private and application networks. You need three network adapters on the head node for this topology.
EnterprisePrivateApplication: All nodes are connected to enterprise, private, and application networks. You need three network adapters on the head node for this topology.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
1 |
|
Default Value |
no default |
|
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.
- None.
Notes
-
Use the Get-HpcNetworkInterface | Format-List cmdlet to get the names of the network interfaces for your HPC cluster.
-
You must be a cluster administrator to run this cmdlet successfully.
Examples
EXAMPLE 1
Sets the network topology for the HPC cluster to Enterprise. This example also sets a network interface named "NIC_1" to be the enterprise network interface and turns on the firewall for the Enterprise network on all nodes in the HPC cluster.
| Copy Code |
|
|---|---|
Set-HpcNetwork -Topology Enterprise -Enterprise 'NIC_1' -EnterpriseFirewall $true |
|
EXAMPLE 2
Sets the topology for the HPC cluster to Private. This example also sets two different network interfaces on the head node to be the Enterprise network interface and the Private network interface. For the Private network interface, this example sets the subnet and the Dynamic Host Configuration Protocol (DHCP) settings.
| Copy Code |
|
|---|---|
Set-HpcNetwork -Topology Private -Enterprise 'NIC_1' -EnterpriseFirewall $true -Private 'NIC_2' -PrivateIpAddress 192.168.0.1 -PrivateSubnetMask 255.255.0.0 -PrivateDHCP $true -PrivateDHCPStartAddress 192.168.0.10 -PrivateDHCPEndAddress 192.168.0.200 -PrivateDHCPGateway 192.168.0.1 -PrivateDHCPDns 192.168.0.1 -PrivateNat $true -PrivateFirewall $false |
|
EXAMPLE 3
Sets the topology for the HPC cluster to EnterprisePrivate. This example also sets two different network interfaces on the head node to be the Enterprise network interface and the Private network interface. For the Private network interface, this example sets the subnet and the Dynamic Host Configuration Protocol (DHCP) settings.
| Copy Code |
|
|---|---|
Set-HpcNetwork -Topology EnterprisePrivate -Enterprise 'NIC_1' -EnterpriseFirewall $true -Private 'NIC_2' -PrivateIpAddress 192.168.0.1 -PrivateSubnetMask 255.255.0.0 -PrivateDHCP $true -PrivateDHCPStartAddress 192.168.0.10 -PrivateDHCPEndAddress 192.168.0.200 -PrivateDHCPDns 192.168.0.1 -PrivateNat $false -PrivateFirewall $false |
|
EXAMPLE 4
Sets the topology for the HPC cluster to PrivateApplication. This example also sets three different network interfaces on the head node to be the Enterprise network interface, the Private network interface, and the Application network interface. For the Private and Application network interfaces, this example sets the subnet and the Dynamic Host Configuration Protocol (DHCP) settings.
| Copy Code |
|
|---|---|
Set-HpcNetwork -Topology PrivateApplication -Enterprise 'NIC_1' -EnterpriseFirewall $true -Private 'NIC_2' -PrivateIpAddress 192.168.0.1 -PrivateSubnetMask 255.255.0.0 -PrivateDHCP $true -PrivateDHCPStartAddress 192.168.0.10 -PrivateDHCPEndAddress 192.168.0.200 -PrivateDHCPGateway 192.168.0.1 -PrivateDHCPDns 192.168.0.1 -PrivateNat $true -PrivateFirewall $false -Application 'NIC_3' -ApplicationIpAddress 10.0.0.1 -ApplicationSubnetMask 255.255.0.0 -ApplicationDHCP $true -ApplicationDHCPStartAddress 10.0.0.10 -ApplicationDHCPEndAddress 10.0.0.100 -ApplicationDHCPGateway 10.0.0.1 -ApplicationDHCPDns 10.0.0.1 -ApplicationNat $false -ApplicationFirewall $false |
|
EXAMPLE 5
Sets the topology for the HPC cluster to EnterprisePrivateApplication. This example also sets three different network interfaces on the head node to be the Enterprise network interface, the Private network interface, and the Application network interface. For the Private and Application network interfaces, this example sets the subnet and the Dynamic Host Configuration Protocol (DHCP) settings.
| Copy Code |
|
|---|---|
Set-HpcNetwork -Topology EnterprisePrivateApplication -Enterprise 'NIC_1' -EnterpriseFirewall $true -Private 'NIC_2' -PrivateIpAddress 192.168.0.1 -PrivateSubnetMask 255.255.0.0 -PrivateDHCP $true -PrivateDHCPStartAddress 192.168.0.10 -PrivateDHCPEndAddress 192.168.0.200 -PrivateDHCPDns 192.168.0.1 -PrivateNat $false -PrivateFirewall $false -Application 'NIC_3' -ApplicationIpAddress 10.0.0.1 -ApplicationSubnetMask 255.255.0.0 -ApplicationDHCP $true -ApplicationDHCPStartAddress 10.0.0.10 -ApplicationDHCPEndAddress 10.0.0.100 -ApplicationDHCPDns 10.0.0.1 -ApplicationNat $false -ApplicationFirewall $false |
|
EXAMPLE 6
Registers the private network interface in DNS using the primary DNS suffix appended to the computer name.
| Copy Code |
|
|---|---|
Set-HpcNetwork -PrivateDnsRegistrationType FullDnsNameOnly |
|