Set-NlbCluster
Edits the configuration of a NLB cluster.
Syntax
NonPipeline (Default)
Set-NlbCluster
[[-HostName] <String>]
[-InterfaceName] <String>
[-ClusterPrimaryIP <IPAddress>]
[-Name <String>]
[-OperationMode <ClusterMode>]
[<CommonParameters>]
Pipeline
Set-NlbCluster
-InputObject <Cluster[]>
[-ClusterPrimaryIP <IPAddress>]
[-Name <String>]
[-OperationMode <ClusterMode>]
[<CommonParameters>]
Description
The Set-NlbCluster cmdlet edits the configuration of a Network Load Balancing (NLB) cluster. The configuration changes you can make include the cluster operation mode, the cluster name, and the cluster primary IP address.
This operation changes the configuration on all cluster nodes. As a result, the NLB cluster restarts the convergence process on all nodes to guarantee that configuration changes have been applied on all nodes and that a consistent state is reached. Any additional operations on the NLB cluster should not be initiated until all cluster nodes have completed the convergence process and are back to the converged state.
ps_nlbc_checkstate_remark
Examples
Example 1: Change the cluster name
PS C:\>Get-NlbCluster | Set-NlbCluster -Name " NewCluster001"
Name IPAddress SubnetMask Mode
---- --------- ---------- ----
NewCluster001 fe80::b349:6945:... :: UNICAST
This command changes the cluster name to NewCluster001.
Example 2: Change the cluster operation mode
PS C:\>Get-NlbCluster | Set-NlbCluster -OperationMode MULTICAST
Name IPAddress SubnetMask Mode
---- --------- ---------- ----
newcluster fe80::b349:6945:... :: MULTICAST
This command changes the cluster operation mode to MULTICAST.
Example 3: Change the cluster primary IP address
PS C:\>Get-NlbCluster | Set-NlbCluster -ClusterPrimaryIP 2.53.0.120
Name IPAddress SubnetMask Mode
---- --------- ---------- ----
newcluster 2.53.0.120 255.0.0.0 MULTICAST
This command changes the cluster primary IP address to one of the other cluster virtual IP addresses on the cluster.
Parameters
-ClusterPrimaryIP
Specifies the IP address to use as the cluster primary IP address. The IP address must be one of the existing virtual IP addresses on the cluster.
Parameter properties
| Type: | IPAddress |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | PrimaryIP, PIP |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HostName
Specifies the name of the cluster host against which this cmdlet is run.
If this parameter is omitted or a value of . is entered, then the local cluster is assumed.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Host, HN, H |
Parameter sets
NonPipeline
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the cluster to set.
Parameter properties
| Type: | Cluster[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Pipeline
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-InterfaceName
Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Interface, IN, I |
Parameter sets
NonPipeline
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the new name of the cluster that this cmdlet sets.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ClusterName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OperationMode
Specifies the new operation mode for the cluster. The acceptable values for this parameter are:
- IGMPMULTICAST
- MULTICAST
- UNICAST
Parameter properties
| Type: | ClusterMode |
| Default value: | None |
| Accepted values: | Unicast, Multicast, IgmpMulticast |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.