Edit

Share via


New-WorkgroupCluster

Creates a new workgroup cluster.

Syntax

Default (Default)

New-WorkgroupCluster
    [[-Node] <String[]>]
    [[-Credentials] <PSCredential[]>]
    [[-Name] <String>]
    [[-StaticAddress] <String[]>]
    [[-IgnoreNetwork] <String[]>]
    [[-ManagementPointNetworkType] <AdminAccessPointResType>]
    [[-AdministrativeAccessPoint] <AdminAccessPoint>]
    [-NoStorage]
    [-S2D]
    [-Force]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]

Description

The New-WorkgroupCluster cmdlet creates a new workgroup cluster.

Examples

EXAMPLE 1

New-WorkgroupCluster -Node "Node1", "Node2" -Credentials $cred1, $cred2 -Name "Cluster1"

This example creates a new workgroup cluster named Cluster1 with Node1 and Node2 using the credentials in $cred1 and $cred2.

Note: Only None and DNS are supported for AdministrativeAccessPoint.

Parameters

-AdministrativeAccessPoint

Specifies the type of administrative access point that the cmdlet creates for the cluster. Acceptable values are:

  • DNS: The cmdlet creates an administrative access point for the cluster. The administrative access point is registered in DNS but isn't enabled in Active Directory Domain Services.
  • None

The cmdlet doesn't create an administrative access point for the cluster. Some clustered roles and functionality might not be available for a cluster that doesn't have an administrative access point. Also, you cannot use Failover Cluster Manager to manage a cluster that doesn't have an administrative access point.

Parameter properties

Type:AdminAccessPoint
Default value:None
Accepted values:None, Dns
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:7
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
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

-Credentials

An array of credentials for the nodes.

Parameter properties

Type:

PSCredential[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:False
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

-IgnoreNetwork

Specifies one or more networks to ignore when running the cmdlet. Networks with DHCP enabled are always included, but other networks need a static address to be specified using the StaticAddress parameter or should be explicitly ignored with this IgnoreNetwork parameter.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:5
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ManagementPointNetworkType

Specifies the network configuration used to determine IP address settings. Acceptable values are:

  • Automatic: Automatically detects the appropriate setting.
    • If SQL Server is running in Azure, it uses Distributed.
    • If SQL Server is running on-premises, it uses Singleton.
  • Singleton: The traditional method of DHCP or static IP address.
  • Distributed: Uses a Distributed Network Name by using Node IP addresses.

For on-prem SQL Server, if the value is set to Automatic, it defaults to Singleton.

Parameter properties

Type:AdminAccessPointResType
Default value:None
Accepted values:Automatic, Singleton, Distributed
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The name of the workgroup cluster.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Node

An array of nodes to be included in the cluster.

Parameter properties

Type:

String[]

Default value:@()
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoStorage

Specifies that shared storage is ignored for the workgroup cluster node.

Parameter properties

Type:SwitchParameter
Default value:False
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

-S2D

Specifies whether to enable Storage Spaces Direct when creating the workgroup cluster.

Parameter properties

Type:SwitchParameter
Default value:False
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

-StaticAddress

Specifies one or more static addresses to use when running the cmdlet. Networks with DHCP enabled are always included, but other networks need a static address to be specified using the StaticAddress parameter or should be explicitly ignored with this IgnoreNetwork parameter.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet isn't run.

Parameter properties

Type:SwitchParameter
Default value:False
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.