From 5095e0ec953c40bb6e632e694f8f6354b2d0691e Mon Sep 17 00:00:00 2001 From: Jason Gerend <7906263+JasonGerend@users.noreply.github.com> Date: Wed, 23 Apr 2025 11:40:33 -0700 Subject: [PATCH 1/8] Draft of Add-ClusterFabricControllerManagerRole --- .../Add-ClusterFabricControllerManagerRole.md | 92 +++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 docset/winserver2025-ps/failoverclusters/Add-ClusterFabricControllerManagerRole.md diff --git a/docset/winserver2025-ps/failoverclusters/Add-ClusterFabricControllerManagerRole.md b/docset/winserver2025-ps/failoverclusters/Add-ClusterFabricControllerManagerRole.md new file mode 100644 index 0000000000..27dcec50cb --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Add-ClusterFabricControllerManagerRole.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +online version: +schema: 2.0.0 +ms.date: 04/22/2025 +ai-usage: ai-generated +--- + +# Add-ClusterFabricControllerManagerRole + +## SYNOPSIS + +Adds a Fabric Controller Manager role to a failover cluster. + +## SYNTAX + +``` +Add-ClusterFabricControllerManagerRole [-InputObject ] [-Cluster ] [] +``` + +## DESCRIPTION + +The Add-ClusterFabricControllerManagerRole cmdlet adds a Fabric Controller Manager role to an +existing failover cluster. This role is used to integrate and manage fabric resources within the +cluster, enabling advanced orchestration and management scenarios. You can specify the target +cluster by name or use the current cluster context. Optionally, you can provide an input object +representing the cluster to which the role will be added. + +## EXAMPLES + +### Add a Fabric Controller Manager role to a specific cluster + +This example adds a Fabric Controller Manager role to the cluster named Cluster01. + +```powershell +Add-ClusterFabricControllerManagerRole -Cluster "Cluster01" +``` + +## PARAMETERS + +### -Cluster + +Specifies the name of the cluster to which the Fabric Controller Manager role will be added. If this parameter is not specified, the cmdlet uses the local cluster context. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Specifies a cluster object to which the Fabric Controller Manager role will be added. You can pass a cluster object through the pipeline to this parameter. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +You can pipe a cluster object to this cmdlet to specify the target cluster for the Fabric Controller Manager role. + +## OUTPUTS + +### System.Object + +This cmdlet returns an object representing the newly added Fabric Controller Manager role or the result of the operation. + +## NOTES + +## RELATED LINKS From 81980a028f51c471172a4e7f39ec5dc7c82abcfa Mon Sep 17 00:00:00 2001 From: Jason Gerend <7906263+JasonGerend@users.noreply.github.com> Date: Wed, 23 Apr 2025 17:47:18 -0700 Subject: [PATCH 2/8] Updating for 2025 --- .../Remove-WorkgroupClusterCertificates.md | 86 +++++++++++++++ .../Start-WorkgroupCluster.md | 104 ++++++++++++++++++ .../failoverclusters/Stop-WorkgroupCluster.md | 104 ++++++++++++++++++ 3 files changed, 294 insertions(+) create mode 100644 docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md create mode 100644 docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md create mode 100644 docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md diff --git a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md new file mode 100644 index 0000000000..9e885d359f --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md @@ -0,0 +1,86 @@ +--- +external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml +Module Name: FailoverClusters +online version: +schema: 2.0.0 +--- + +# Remove-WorkgroupClusterCertificates + +## SYNOPSIS +Removes certificates issued by a specific issuer from the local machine and current user certificate stores. + +## SYNTAX + +``` +Remove-WorkgroupClusterCertificates [[-Authority] ] [-Force] [] +``` + +## DESCRIPTION +The Remove-WorkgroupClusterCertificates function removes certificates from the following certificate stores: +- Cert:\LocalMachine\My +- Cert:\LocalMachine\Local Cert Issuer +- Cert:\CurrentUser\My +- Cert:\CurrentUser\CA + +Certificates are filtered for those issued by issuers starring with PKU2UAuthority. + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-WorkgroupClusterCertificates -Force +``` + +Removes all certificates issued by "CN=PKU2UAuthority*" from the certificate stores without prompting for confirmation. + +### EXAMPLE 2 +``` +Remove-WorkgroupClusterCertificates +``` + +Prompts for confirmation before removing each certificate issued by "CN=PKU2UAuthority*" from the certificate stores. + +## PARAMETERS + +### -Authority +{{ Fill Authority Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: PKU2UAuthority* +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates whether to force the removal of certificates without prompting for confirmation. +By default, the value is $false. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md new file mode 100644 index 0000000000..d4a8a038f9 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml +Module Name: FailoverClusters +online version: +schema: 2.0.0 +--- + +# Start-WorkgroupCluster + +## SYNOPSIS +Starts a workgroup cluster. + +## SYNTAX + +``` +Start-WorkgroupCluster [[-Node] ] [[-Credentials] ] [-IgnorePersistentState] + [-AuthenticationMethod] [] +``` + +## DESCRIPTION +The Start-WorkgroupCluster function starts a workgroup cluster. + +## EXAMPLES + +### EXAMPLE 1 +``` +Start-WorkgroupCluster -Node "Node1", "Node2" -Credentials $cred1, $cred2 +``` + +This example starts the cluster. + +## PARAMETERS + +### -AuthenticationMethod +{{ Fill AuthenticationMethod Description }} + +```yaml +Type: WorkgroupClusterAuthenticationMethod +Parameter Sets: (All) +Aliases: +Accepted values: Certificates, NoCertificates + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credentials +An array of credentials for the nodes. + +```yaml +Type: PSCredential[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnorePersistentState +{{ Fill IgnorePersistentState Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +An array of nodes that form the current cluster. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: @() +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md new file mode 100644 index 0000000000..33b6439f98 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml +Module Name: FailoverClusters +online version: +schema: 2.0.0 +--- + +# Stop-WorkgroupCluster + +## SYNOPSIS +Stop a workgroup cluster. + +## SYNTAX + +``` +Stop-WorkgroupCluster [[-Node] ] [[-Credentials] ] [-Confirm] + [-AuthenticationMethod] [] +``` + +## DESCRIPTION +The Stop-WorkgroupCluster function stops a workgroup cluster. + +## EXAMPLES + +### EXAMPLE 1 +``` +Stop-WorkgroupCluster -Node "Node1", "Node2" -Credentials $cred1, $cred2 +``` + +This example stops the cluster. + +## PARAMETERS + +### -AuthenticationMethod +{{ Fill AuthenticationMethod Description }} + +```yaml +Type: WorkgroupClusterAuthenticationMethod +Parameter Sets: (All) +Aliases: +Accepted values: Certificates, NoCertificates + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credentials +An array of credentials for the nodes. + +```yaml +Type: PSCredential[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +An array of nodes that form the current cluster. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: @() +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS From 5fd4083793a852db6d037eb80081d961511ea7c5 Mon Sep 17 00:00:00 2001 From: Jason Gerend <7906263+JasonGerend@users.noreply.github.com> Date: Wed, 23 Apr 2025 17:48:54 -0700 Subject: [PATCH 3/8] Remove obsolete cmdlet --- .../Add-ClusterFabricControllerManagerRole.md | 92 ------------------- 1 file changed, 92 deletions(-) delete mode 100644 docset/winserver2025-ps/failoverclusters/Add-ClusterFabricControllerManagerRole.md diff --git a/docset/winserver2025-ps/failoverclusters/Add-ClusterFabricControllerManagerRole.md b/docset/winserver2025-ps/failoverclusters/Add-ClusterFabricControllerManagerRole.md deleted file mode 100644 index 27dcec50cb..0000000000 --- a/docset/winserver2025-ps/failoverclusters/Add-ClusterFabricControllerManagerRole.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml -Module Name: FailoverClusters -online version: -schema: 2.0.0 -ms.date: 04/22/2025 -ai-usage: ai-generated ---- - -# Add-ClusterFabricControllerManagerRole - -## SYNOPSIS - -Adds a Fabric Controller Manager role to a failover cluster. - -## SYNTAX - -``` -Add-ClusterFabricControllerManagerRole [-InputObject ] [-Cluster ] [] -``` - -## DESCRIPTION - -The Add-ClusterFabricControllerManagerRole cmdlet adds a Fabric Controller Manager role to an -existing failover cluster. This role is used to integrate and manage fabric resources within the -cluster, enabling advanced orchestration and management scenarios. You can specify the target -cluster by name or use the current cluster context. Optionally, you can provide an input object -representing the cluster to which the role will be added. - -## EXAMPLES - -### Add a Fabric Controller Manager role to a specific cluster - -This example adds a Fabric Controller Manager role to the cluster named Cluster01. - -```powershell -Add-ClusterFabricControllerManagerRole -Cluster "Cluster01" -``` - -## PARAMETERS - -### -Cluster - -Specifies the name of the cluster to which the Fabric Controller Manager role will be added. If this parameter is not specified, the cmdlet uses the local cluster context. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Specifies a cluster object to which the Fabric Controller Manager role will be added. You can pass a cluster object through the pipeline to this parameter. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - -You can pipe a cluster object to this cmdlet to specify the target cluster for the Fabric Controller Manager role. - -## OUTPUTS - -### System.Object - -This cmdlet returns an object representing the newly added Fabric Controller Manager role or the result of the operation. - -## NOTES - -## RELATED LINKS From 62568cda6b068d097561bfd0b86db90c0f71d369 Mon Sep 17 00:00:00 2001 From: Jason Gerend <7906263+JasonGerend@users.noreply.github.com> Date: Wed, 23 Apr 2025 17:54:57 -0700 Subject: [PATCH 4/8] Changed cmdlets --- .../Add-WorkgroupClusterNode.md | 45 +++-- .../failoverclusters/New-WorkgroupCluster.md | 114 ++++++------ .../Remove-WorkgroupCluster.md | 42 +++-- .../Remove-WorkgroupClusterNode.md | 110 +++++++----- .../failoverclusters/Test-WorkgroupCluster.md | 163 ++++++++++-------- 5 files changed, 278 insertions(+), 196 deletions(-) diff --git a/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md b/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md index 501c03b6b4..1137ef34b1 100644 --- a/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md +++ b/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md @@ -17,7 +17,8 @@ Adds a node to a workgroup cluster. ``` Add-WorkgroupClusterNode [-Node] [-Credentials] [-Name] - [-Credential] [-NoStorage] [-Confirm] [-WhatIf] [] + [-Credential] [-NoStorage] [-Confirm] [-WhatIf] + [-AuthenticationMethod] [] ``` ## DESCRIPTION @@ -42,17 +43,33 @@ This example adds `Node3` to the cluster whose membership is comprised of `Node1 ## PARAMETERS -### -Node +### -AuthenticationMethod +{{ Fill AuthenticationMethod Description }} -An array of nodes to be added to the cluster. +```yaml +Type: WorkgroupClusterAuthenticationMethod +Parameter Sets: (All) +Aliases: +Accepted values: Certificates, NoCertificates + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +The credential for the node to be added. ```yaml -Type: String[] +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -63,7 +80,7 @@ Accept wildcard characters: False An array of credentials for the nodes. ```yaml -Type: PSCredential[] +Type: System.Management.Automation.PSCredential[] Parameter Sets: (All) Aliases: @@ -79,7 +96,7 @@ Accept wildcard characters: False The name of the node to be added. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -90,17 +107,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential +### -Node -The credential for the node to be added. +An array of nodes to be added to the cluster. ```yaml -Type: PSCredential +Type: System.String[] Parameter Sets: (All) Aliases: Required: True -Position: 4 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -111,7 +128,7 @@ Accept wildcard characters: False Specifies that shared storage is ignored for the workgroup cluster node. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -127,7 +144,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -143,7 +160,7 @@ Accept wildcard characters: False Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: diff --git a/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md index 1c4c0fbd37..93bf228bf1 100644 --- a/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md @@ -18,9 +18,9 @@ Creates a new workgroup cluster. ``` New-WorkgroupCluster [[-Node] ] [[-Credentials] ] [[-Name] ] [[-StaticAddress] ] [[-IgnoreNetwork] ] - [[-ManagementPointNetworkType] ] - [[-AdministrativeAccessPoint] ] [-NoStorage] [-S2D] [-Force] [-Confirm] [-WhatIf] - [] + [[-ManagementPointNetworkType] ] [[-AdministrativeAccessPoint] ] + [-NoStorage] [-S2D] [-Force] [-Confirm] [-WhatIf] + [-AuthenticationMethod] [] ``` ## DESCRIPTION @@ -42,68 +42,77 @@ Note: Only None and DNS are supported for AdministrativeAccessPoint. ## PARAMETERS -### -Node +### -AdministrativeAccessPoint -An array of nodes to be included in the cluster. +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. ```yaml -Type: String[] +Type: AdminAccessPoint Parameter Sets: (All) Aliases: +Accepted values: None, Dns Required: False -Position: 1 -Default value: @() +Position: 7 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Credentials - -An array of credentials for the nodes. +### -AuthenticationMethod +{{ Fill AuthenticationMethod Description }} ```yaml -Type: PSCredential[] +Type: WorkgroupClusterAuthenticationMethod Parameter Sets: (All) Aliases: +Accepted values: Certificates, NoCertificates -Required: False -Position: 2 +Required: True +Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name +### -Credentials -The name of the workgroup cluster. +An array of credentials for the nodes. ```yaml -Type: String +Type: System.Management.Automation.PSCredential[] Parameter Sets: (All) Aliases: Required: False -Position: 3 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StaticAddress +### -Force -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. +Forces the command to run without asking for user confirmation. ```yaml -Type: String[] +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 4 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -115,7 +124,7 @@ always included, but other networks need a static address to be specified using **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -151,29 +160,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdministrativeAccessPoint +### -Name -Specifies the type of administrative access point that the cmdlet creates for the cluster. -Acceptable values are: +The name of the workgroup cluster. -- `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` +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: -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. +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node + +An array of nodes to be included in the cluster. ```yaml -Type: AdminAccessPoint +Type: System.String[] Parameter Sets: (All) Aliases: -Accepted values: None, Dns Required: False -Position: 7 -Default value: None +Position: 1 +Default value: @() Accept pipeline input: False Accept wildcard characters: False ``` @@ -183,7 +197,7 @@ Accept wildcard characters: False Specifies that shared storage is ignored for the workgroup cluster node. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -199,7 +213,7 @@ Accept wildcard characters: False Specifies whether to enable Storage Spaces Direct when creating the workgroup cluster. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -210,18 +224,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -StaticAddress -Forces the command to run without asking for user confirmation. +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. ```yaml -Type: SwitchParameter +Type: System.String[] Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 4 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -231,7 +247,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -247,7 +263,7 @@ Accept wildcard characters: False Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: diff --git a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md index f08fbaf834..0db7793bcd 100644 --- a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md @@ -16,8 +16,8 @@ Removes a workgroup cluster. ## SYNTAX ``` -Remove-WorkgroupCluster [[-Node] ] [[-Credentials] ] [-Force] [-Confirm] - [-WhatIf] [] +Remove-WorkgroupCluster [[-Node] ] [[-Credentials] ] [-Force] [-Confirm] [-WhatIf] + [-AuthenticationMethod] [] ``` ## DESCRIPTION @@ -39,18 +39,18 @@ be removed and manual cleanup may be needed. ## PARAMETERS -### -Node - -An array of nodes that form the current cluster. +### -AuthenticationMethod +{{ Fill AuthenticationMethod Description }} ```yaml -Type: String[] +Type: WorkgroupClusterAuthenticationMethod Parameter Sets: (All) Aliases: +Accepted values: Certificates, NoCertificates -Required: False -Position: 1 -Default value: @() +Required: True +Position: 3 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -60,7 +60,7 @@ Accept wildcard characters: False An array of credentials for the nodes. ```yaml -Type: PSCredential[] +Type: System.Management.Automation.PSCredential[] Parameter Sets: (All) Aliases: @@ -76,7 +76,7 @@ Accept wildcard characters: False Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -87,12 +87,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Node + +An array of nodes that form the current cluster. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: @() +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -108,7 +124,7 @@ Accept wildcard characters: False Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: diff --git a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md index e3e63f393b..4361a1a55c 100644 --- a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md +++ b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md @@ -18,7 +18,7 @@ Removes a node from a workgroup cluster. ``` Remove-WorkgroupClusterNode [-Node] [-Credentials] [-Name] [[-Wait] ] [-IgnoreStorageConnectivityLoss] [-CleanupDisks] [-Force] [-Confirm] [-WhatIf] - [] + [-AuthenticationMethod] [] ``` ## DESCRIPTION @@ -51,83 +51,82 @@ Manual cleanup may be required to clear the node state by logging into `Node3` a ## PARAMETERS -### -Node - -An array of nodes in the workgroup cluster. +### -AuthenticationMethod +{{ Fill AuthenticationMethod Description }} ```yaml -Type: String[] +Type: WorkgroupClusterAuthenticationMethod Parameter Sets: (All) Aliases: +Accepted values: Certificates, NoCertificates Required: True -Position: 1 +Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Credentials +### -CleanupDisks -An array of credentials for the nodes. +Removes any residual cluster metadata from the specified disks. This metadata includes information +that the cluster service uses to manage the disks. By cleaning the metadata, the disks are freed +from any old cluster configurations, making them available for new clusters or other purposes. This +cmdlet may prevent potential conflicts that could arise from leftover metadata when reusing disks. ```yaml -Type: PSCredential[] +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: True -Position: 2 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Name +### -Credentials -The name of the node to be removed. If the name isn't included in **Node** parameter, the first -node in the **Node** parameter will be used to remove the node. Additional cleanup will be required -to clear the node state. +An array of credentials for the nodes. ```yaml -Type: String +Type: System.Management.Automation.PSCredential[] Parameter Sets: (All) Aliases: Required: True -Position: 3 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Wait +### -Force -Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified, -then the cmdlet waits for completion. If the value `0` is specified, then the call is initiated and -the cmdlet returns without waiting. +Forces the command to run without asking for user confirmation. ```yaml -Type: Int32 +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 4 -Default value: 0 +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -CleanupDisks +### -IgnoreStorageConnectivityLoss -Removes any residual cluster metadata from the specified disks. This metadata includes information -that the cluster service uses to manage the disks. By cleaning the metadata, the disks are freed -from any old cluster configurations, making them available for new clusters or other purposes. This -cmdlet may prevent potential conflicts that could arise from leftover metadata when reusing disks. +Indicates that this cmdlet doesn't check whether the cluster node contains non-shared storage, if +Storage Spaces Direct is enabled. If you don't specify this parameter, the cmdlet checks whether +this node has any Storage Spaces Direct storage. If this cmdlet finds Storage Spaces Direct storage, +it prompts you for confirmation before it removes the node. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -138,37 +137,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -Name -Forces the command to run without asking for user confirmation. +The name of the node to be removed. If the name isn't included in **Node** parameter, the first +node in the **Node** parameter will be used to remove the node. Additional cleanup will be required +to clear the node state. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 3 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreStorageConnectivityLoss +### -Node -Indicates that this cmdlet doesn't check whether the cluster node contains non-shared storage, if -Storage Spaces Direct is enabled. If you don't specify this parameter, the cmdlet checks whether -this node has any Storage Spaces Direct storage. If this cmdlet finds Storage Spaces Direct storage, -it prompts you for confirmation before it removes the node. +An array of nodes in the workgroup cluster. ```yaml -Type: SwitchParameter +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait + +Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified, +then the cmdlet waits for completion. If the value `0` is specified, then the call is initiated and +the cmdlet returns without waiting. + +```yaml +Type: System.Int32 Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 4 +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -178,7 +194,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -194,7 +210,7 @@ Accept wildcard characters: False Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: diff --git a/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md index 0d68dd5b64..dd0c000bf0 100644 --- a/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md @@ -17,8 +17,9 @@ Tests the configuration of a workgroup cluster. ``` Test-WorkgroupCluster [[-Node] ] [[-Credentials] ] [[-Disk] ] - [[-Pool] ] [[-ReportName] ] [[-Include] ] [[-Ignore] ] - [-Force] [[-Cluster] ] [-Confirm] [-WhatIf] [-Destination] [] + [[-Pool] ] [[-ReportName] ] [[-Include] ] [[-Ignore] ] [-Force] + [[-Cluster] ] [-Confirm] [-WhatIf] [-Destination] + [-AuthenticationMethod] [] ``` ## DESCRIPTION @@ -40,18 +41,35 @@ credentials in `$cred1` and `$cred2`, and additional parameters. ## PARAMETERS -### -Node +### -AuthenticationMethod +{{ Fill AuthenticationMethod Description }} -An array of nodes in the workgroup cluster. +```yaml +Type: WorkgroupClusterAuthenticationMethod +Parameter Sets: (All) +Aliases: +Accepted values: Certificates, NoCertificates + +Required: True +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cluster + +Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is +`.` or it is omitted, then the cmdlet runs on the local cluster. ```yaml -Type: String[] +Type: System.String Parameter Sets: (All) Aliases: Required: False -Position: 2 -Default value: @() +Position: 8 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -61,17 +79,34 @@ Accept wildcard characters: False An array of credentials for the nodes. ```yaml -Type: PSCredential[] +Type: System.Management.Automation.PSCredential[] Parameter Sets: (All) Aliases: Required: False -Position: 3 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Destination + +Specifies the location to which to copy one or more cluster logs. To copy to the current folder, use +`.` for this parameter input. Default location is `C:\Windows\Cluster\Reports`. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 9 +Default value: (Get-Location).Path +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Disk Specifies the disk number or disks for which to run the cmdlet. If the specified disk is online and @@ -93,58 +128,45 @@ Acceptable values are: module. ```yaml -Type: Object[] +Type: System.Object[] Parameter Sets: (All) Aliases: Required: False -Position: 4 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Pool - -Specifies the clustered storage pool or pools for which to run the cmdlet. When the specified -storage pool is online and a virtual disk in the storage pool is assigned to a clustered role or -Cluster Shared Volume, you must also specify the **Force** parameter to take the storage pool -offline for the duration of the storage tests. Otherwise, the command will exit with an error. - -The specified storage pool must be taken offline before running the storage tests. If the **Pool** -parameter isn't specified, storage tests run on all storage pools that are available for use in the -cluster or that are in the cluster resource offline or failed state. - -Acceptable values are: +### -Force -- **System.String**: A string that represents the name of the clustered storage pool or pools. -- **ClusterResource**: A cluster resource object that represents a clustered storage pool. -- **CimInstance#MSFT_StoragePool**: An object returned from `Get-StoragePool`, from the Windows - PowerShell storage module. +Forces the command to run without asking for user confirmation. ```yaml -Type: Object[] +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 5 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ReportName +### -Ignore -Specifies the name of the test report to generate. +Specifies which tests or category of tests to ignore during the validation test run. All other +tests or category of tests will run. ```yaml -Type: String +Type: System.String[] Parameter Sets: (All) Aliases: Required: False -Position: 6 +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -156,62 +178,74 @@ Specifies which tests or category of tests to include during the validation test or category of tests specified will run. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Required: False -Position: 7 +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Ignore +### -Node -Specifies which tests or category of tests to ignore during the validation test run. All other -tests or category of tests will run. +An array of nodes in the workgroup cluster. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Required: False -Position: 8 -Default value: None +Position: 1 +Default value: @() Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -Pool -Forces the command to run without asking for user confirmation. +Specifies the clustered storage pool or pools for which to run the cmdlet. When the specified +storage pool is online and a virtual disk in the storage pool is assigned to a clustered role or +Cluster Shared Volume, you must also specify the **Force** parameter to take the storage pool +offline for the duration of the storage tests. Otherwise, the command will exit with an error. + +The specified storage pool must be taken offline before running the storage tests. If the **Pool** +parameter isn't specified, storage tests run on all storage pools that are available for use in the +cluster or that are in the cluster resource offline or failed state. + +Acceptable values are: + +- **System.String**: A string that represents the name of the clustered storage pool or pools. +- **ClusterResource**: A cluster resource object that represents a clustered storage pool. +- **CimInstance#MSFT_StoragePool**: An object returned from `Get-StoragePool`, from the Windows + PowerShell storage module. ```yaml -Type: SwitchParameter +Type: System.Object[] Parameter Sets: (All) Aliases: Required: False -Position: 9 -Default value: False +Position: 4 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Cluster +### -ReportName -Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is -`.` or it is omitted, then the cmdlet runs on the local cluster. +Specifies the name of the test report to generate. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: False -Position: 10 +Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -222,12 +256,12 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 11 +Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False @@ -238,34 +272,17 @@ Accept wildcard characters: False Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 12 +Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Destination - -Specifies the location to which to copy one or more cluster logs. To copy to the current folder, use -`.` for this parameter input. Default location is `C:\Windows\Cluster\Reports`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 13 -Default value: (Get-Location).Path -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, From 17ad8a0c98bbf486fda87eb79fc6ebf90ecf03f5 Mon Sep 17 00:00:00 2001 From: Jason Gerend <7906263+JasonGerend@users.noreply.github.com> Date: Thu, 24 Apr 2025 11:46:30 -0700 Subject: [PATCH 5/8] AI descriptions added --- .../Add-WorkgroupClusterNode.md | 21 ++++++++++++++++-- .../failoverclusters/New-WorkgroupCluster.md | 18 +++++++++++++-- .../Remove-WorkgroupCluster.md | 15 +++++++++++-- .../Remove-WorkgroupClusterCertificates.md | 14 ++++++++---- .../Remove-WorkgroupClusterNode.md | 22 +++++++++++++++---- .../Start-WorkgroupCluster.md | 17 +++++++++++--- .../failoverclusters/Stop-WorkgroupCluster.md | 15 +++++++++++-- .../failoverclusters/Test-WorkgroupCluster.md | 19 +++++++++++++++- 8 files changed, 121 insertions(+), 20 deletions(-) diff --git a/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md b/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md index 1137ef34b1..6cc3c4db24 100644 --- a/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md +++ b/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md @@ -23,7 +23,7 @@ Add-WorkgroupClusterNode [-Node] [-Credentials] [-Na ## DESCRIPTION -The `Add-WorkgroupClusterNode` cmdlet adds a node to a workgroup cluster. +The `Add-WorkgroupClusterNode` cmdlet adds a node to a workgroup cluster. This cmdlet allows you to expand an existing workgroup cluster by adding a new node, specifying the required credentials and authentication method. The node can be added with or without shared storage, depending on your configuration. ## EXAMPLES @@ -44,7 +44,9 @@ This example adds `Node3` to the cluster whose membership is comprised of `Node1 ## PARAMETERS ### -AuthenticationMethod -{{ Fill AuthenticationMethod Description }} +Specifies the authentication method to use when adding the node to the workgroup cluster. Acceptable values are: +- `Certificates`: Uses certificate-based authentication for secure communication between nodes. +- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates. ```yaml Type: WorkgroupClusterAuthenticationMethod @@ -180,8 +182,23 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### System.String[] +You can pipe an array of node names to this cmdlet. + +### System.Management.Automation.PSCredential[] +You can pipe an array of credentials to this cmdlet. + +### System.String +You can pipe the name of the node to be added. + +### System.Management.Automation.PSCredential +You can pipe the credential for the node to be added. + ## OUTPUTS +### None +This cmdlet does not generate any output. It performs the operation of adding a node to a workgroup cluster. + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md index 93bf228bf1..d56c1126cf 100644 --- a/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md @@ -25,7 +25,7 @@ New-WorkgroupCluster [[-Node] ] [[-Credentials] ] [[-N ## DESCRIPTION -The `New-WorkgroupCluster` cmdlet creates a new workgroup cluster. +The `New-WorkgroupCluster` cmdlet creates a new workgroup cluster. This cmdlet allows you to specify the nodes, credentials, cluster name, network configuration, and authentication method for the new cluster. You can configure the cluster to use certificate-based or local account authentication, and optionally enable Storage Spaces Direct or specify static addresses and networks to ignore. ## EXAMPLES @@ -70,7 +70,9 @@ Accept wildcard characters: False ``` ### -AuthenticationMethod -{{ Fill AuthenticationMethod Description }} +Specifies the authentication method to use when creating the workgroup cluster. Acceptable values are: +- `Certificates`: Uses certificate-based authentication for secure communication between nodes. +- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates. ```yaml Type: WorkgroupClusterAuthenticationMethod @@ -283,8 +285,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### System.String[] +You can pipe an array of node names to this cmdlet. + +### System.Management.Automation.PSCredential[] +You can pipe an array of credentials to this cmdlet. + +### System.String +You can pipe the name of the cluster to be created. + ## OUTPUTS +### None +This cmdlet does not generate any output. It performs the operation of creating a new workgroup cluster. + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md index 0db7793bcd..16953b5b8a 100644 --- a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md @@ -22,7 +22,7 @@ Remove-WorkgroupCluster [[-Node] ] [[-Credentials] ] [ ## DESCRIPTION -The `Remove-WorkgroupCluster` cmdlet removes a workgroup cluster. +The `Remove-WorkgroupCluster` cmdlet removes a workgroup cluster. This cmdlet disconnects and removes all nodes from the specified workgroup cluster, using the provided credentials and authentication method. If communication is lost with a node or the cluster membership is incomplete, manual cleanup may be required. ## EXAMPLES @@ -40,7 +40,9 @@ be removed and manual cleanup may be needed. ## PARAMETERS ### -AuthenticationMethod -{{ Fill AuthenticationMethod Description }} +Specifies the authentication method to use when removing the workgroup cluster. Acceptable values are: +- `Certificates`: Uses certificate-based authentication for secure communication between nodes. +- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates. ```yaml Type: WorkgroupClusterAuthenticationMethod @@ -144,8 +146,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### System.String[] +You can pipe an array of node names to this cmdlet. + +### System.Management.Automation.PSCredential[] +You can pipe an array of credentials to this cmdlet. + ## OUTPUTS +### None +This cmdlet does not generate any output. It performs the operation of removing a workgroup cluster. + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md index 9e885d359f..b9c4669d93 100644 --- a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md +++ b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md @@ -20,10 +20,11 @@ Remove-WorkgroupClusterCertificates [[-Authority] ] [-Force] [ [-Credentials] [ ## DESCRIPTION -The `Remove-WorkgroupCluster` function removes a node from the membership in a workgroup Cluster. -The rest of the parameters will be forwarded to the `Remove-ClusterNode` function. Please refer to -the documentation for the +The `Remove-WorkgroupClusterNode` function removes a node from the membership in a workgroup +cluster. The rest of the parameters will be forwarded to the `Remove-ClusterNode` function. Please +refer to the documentation for the [Remove-ClusterNode](/powershell/module/failoverclusters/remove-clusternode) cmdlet. ## EXAMPLES @@ -52,7 +52,9 @@ Manual cleanup may be required to clear the node state by logging into `Node3` a ## PARAMETERS ### -AuthenticationMethod -{{ Fill AuthenticationMethod Description }} +Specifies the authentication method to use when removing the node from the workgroup cluster. Acceptable values are: +- `Certificates`: Uses certificate-based authentication for secure communication between nodes. +- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates. ```yaml Type: WorkgroupClusterAuthenticationMethod @@ -230,8 +232,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### System.String[] +You can pipe an array of node names to this cmdlet. + +### System.Management.Automation.PSCredential[] +You can pipe an array of credentials to this cmdlet. + +### System.String +You can pipe the name of the node to be removed. + ## OUTPUTS +### None +This cmdlet does not generate any output. + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md index d4a8a038f9..bedaf280f7 100644 --- a/docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md @@ -18,7 +18,7 @@ Start-WorkgroupCluster [[-Node] ] [[-Credentials] ] [- ``` ## DESCRIPTION -The Start-WorkgroupCluster function starts a workgroup cluster. +The Start-WorkgroupCluster function starts a workgroup cluster. This cmdlet brings the specified workgroup cluster online, using the provided credentials and authentication method. You can optionally ignore the persistent state of the cluster when starting it. ## EXAMPLES @@ -32,7 +32,9 @@ This example starts the cluster. ## PARAMETERS ### -AuthenticationMethod -{{ Fill AuthenticationMethod Description }} +Specifies the authentication method to use when starting the workgroup cluster. Acceptable values are: +- `Certificates`: Uses certificate-based authentication for secure communication between nodes. +- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates. ```yaml Type: WorkgroupClusterAuthenticationMethod @@ -63,7 +65,7 @@ Accept wildcard characters: False ``` ### -IgnorePersistentState -{{ Fill IgnorePersistentState Description }} +Indicates that the cmdlet should start the cluster without restoring the previous persistent state. This can be useful if you want to start the cluster in a clean state, ignoring any saved cluster state from previous operations. ```yaml Type: SwitchParameter @@ -97,8 +99,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### System.String[] +You can pipe an array of node names to this cmdlet. + +### System.Management.Automation.PSCredential[] +You can pipe an array of credentials to this cmdlet. + ## OUTPUTS +### None +This cmdlet does not generate any output. It performs the operation of starting a workgroup cluster. + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md index 33b6439f98..d9e246ec3e 100644 --- a/docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md @@ -18,7 +18,7 @@ Stop-WorkgroupCluster [[-Node] ] [[-Credentials] ] [-C ``` ## DESCRIPTION -The Stop-WorkgroupCluster function stops a workgroup cluster. +The Stop-WorkgroupCluster function stops a workgroup cluster. This cmdlet takes the specified workgroup cluster offline, using the provided credentials and authentication method. You can optionally prompt for confirmation before stopping the cluster. ## EXAMPLES @@ -32,7 +32,9 @@ This example stops the cluster. ## PARAMETERS ### -AuthenticationMethod -{{ Fill AuthenticationMethod Description }} +Specifies the authentication method to use when stopping the workgroup cluster. Acceptable values are: +- `Certificates`: Uses certificate-based authentication for secure communication between nodes. +- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates. ```yaml Type: WorkgroupClusterAuthenticationMethod @@ -97,8 +99,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### System.String[] +You can pipe an array of node names to this cmdlet. + +### System.Management.Automation.PSCredential[] +You can pipe an array of credentials to this cmdlet. + ## OUTPUTS +### None +This cmdlet does not generate any output. It performs the operation of stopping a workgroup cluster. + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md index dd0c000bf0..552d1c9a81 100644 --- a/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md @@ -42,7 +42,9 @@ credentials in `$cred1` and `$cred2`, and additional parameters. ## PARAMETERS ### -AuthenticationMethod -{{ Fill AuthenticationMethod Description }} +Specifies the authentication method to use when testing the workgroup cluster. Acceptable values are: +- `Certificates`: Uses certificate-based authentication for secure communication between nodes. +- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates. ```yaml Type: WorkgroupClusterAuthenticationMethod @@ -292,8 +294,23 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### System.String[] +You can pipe an array of node names to this cmdlet. + +### System.Management.Automation.PSCredential[] +You can pipe an array of credentials to this cmdlet. + +### System.Object[] +You can pipe an array of disk or storage pool objects to this cmdlet. + +### System.String +You can pipe the name of the cluster, report, or destination path to this cmdlet. + ## OUTPUTS +### Microsoft.FailoverClusters.PowerShell.ClusterValidationReport +Returns a ClusterValidationReport object that contains the results of the cluster validation tests, including the status of each test and the location of the generated report. + ## NOTES ## RELATED LINKS From 1d02d91b62c5f8afc73ffb343092ddc4933645ba Mon Sep 17 00:00:00 2001 From: Jason Gerend <7906263+JasonGerend@users.noreply.github.com> Date: Thu, 24 Apr 2025 12:07:39 -0700 Subject: [PATCH 6/8] More AI and manual edits --- .../Add-WorkgroupClusterNode.md | 2 +- .../failoverclusters/New-WorkgroupCluster.md | 15 +++++++------- .../Remove-WorkgroupCluster.md | 4 ++-- .../Remove-WorkgroupClusterCertificates.md | 2 ++ .../Remove-WorkgroupClusterNode.md | 20 +++++++++---------- .../Start-WorkgroupCluster.md | 2 ++ .../failoverclusters/Stop-WorkgroupCluster.md | 2 ++ .../failoverclusters/Test-WorkgroupCluster.md | 2 +- 8 files changed, 27 insertions(+), 22 deletions(-) diff --git a/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md b/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md index 6cc3c4db24..922f936367 100644 --- a/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md +++ b/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml Module Name: FailoverClusters -ms.date: 09/11/2024 +ms.date: 04/24/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-workgroupclusternode?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Add-WorkgroupClusterNode diff --git a/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md index d56c1126cf..45c387d0bd 100644 --- a/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md @@ -1,16 +1,18 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Creates a new workgroup cluster with the specified nodes, credentials, and configuration options. external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml Module Name: FailoverClusters -ms.date: 09/11/2024 +ms.date: 04/24/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/new-workgroupcluster?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-WorkgroupCluster +ai-usage: ai-generated --- # New-WorkgroupCluster ## SYNOPSIS + Creates a new workgroup cluster. ## SYNTAX @@ -29,17 +31,14 @@ The `New-WorkgroupCluster` cmdlet creates a new workgroup cluster. This cmdlet a ## EXAMPLES -### EXAMPLE 1 +### Example 1: Create a new workgroup cluster + +This example creates a new workgroup cluster named `Cluster1` with `Node1` and `Node2` using the credentials in `$cred1` and `$cred2`, without creating an administrative access point. ```powershell 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 diff --git a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md index 16953b5b8a..629a40e6a5 100644 --- a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md @@ -1,8 +1,8 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Removes a workgroup cluster. This cmdlet disconnects and removes all nodes from the specified workgroup cluster, using the provided credentials and authentication method. external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml Module Name: FailoverClusters -ms.date: 09/11/2024 +ms.date: 04/24/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-workgroupcluster?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-WorkgroupCluster diff --git a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md index b9c4669d93..3dff54e915 100644 --- a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md +++ b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md @@ -1,8 +1,10 @@ --- +description: Remove certificates issued by a specific issuer from the local machine and current user certificate stores. external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml Module Name: FailoverClusters online version: schema: 2.0.0 +ms.date: 04/24/2025 --- # Remove-WorkgroupClusterCertificates diff --git a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md index afa3a006fb..7fa7869fc5 100644 --- a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md +++ b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md @@ -1,16 +1,18 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Learn how to remove a node from a workgroup cluster using the Remove-WorkgroupClusterNode cmdlet in PowerShell. Includes syntax, examples, and parameter details. external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml Module Name: FailoverClusters -ms.date: 09/11/2024 +ms.date: 04/24/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-workgroupclusternode?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-WorkgroupClusterNode +ai-usage: ai-generated --- # Remove-WorkgroupClusterNode ## SYNOPSIS + Removes a node from a workgroup cluster. ## SYNTAX @@ -30,28 +32,26 @@ refer to the documentation for the ## EXAMPLES -### EXAMPLE 1 +### Example 1: Remove a node from the cluster + +This example removes the node named `Node2` from the cluster that consists of `Node1` and `Node2`. ```powershell Remove-WorkgroupClusterNode -Node "Node1", "Node2" -Credentials $cred1, $cred2 -Name $Node2 ``` -This example removes `Node2` from the cluster membership. +### Example 2: Remove a node not currently in the cluster -### EXAMPLE 2 +This example removes `Node3` from the cluster membership. Manual cleanup may be required to clear the node state by logging into `Node3` and running `Clear-ClusterNode`. ```powershell Remove-WorkgroupClusterNode -Node "Node1", "Node2" -Credentials $cred1, $cred2 -Name $Node3 ``` -This example removes `Node3` from the cluster membership. - -Manual cleanup may be required to clear the node state by logging into `Node3` and running -`Clear-ClusterNode`. - ## PARAMETERS ### -AuthenticationMethod + Specifies the authentication method to use when removing the node from the workgroup cluster. Acceptable values are: - `Certificates`: Uses certificate-based authentication for secure communication between nodes. - `NoCertificates`: Uses local user accounts and passwords for authentication without certificates. diff --git a/docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md index bedaf280f7..903b623221 100644 --- a/docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md @@ -1,8 +1,10 @@ --- +description: Starts a workgroup cluster, bringing the specified nodes online and making them available for use. external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml Module Name: FailoverClusters online version: schema: 2.0.0 +ms.date: 04/24/2025 --- # Start-WorkgroupCluster diff --git a/docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md index d9e246ec3e..a83dd99568 100644 --- a/docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md @@ -1,8 +1,10 @@ --- +description: Stops a workgroup cluster, bringing the specified nodes offline and making them unavailable for use. external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml Module Name: FailoverClusters online version: schema: 2.0.0 +ms.date: 04/24/2025 --- # Stop-WorkgroupCluster diff --git a/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md index 552d1c9a81..b76b875571 100644 --- a/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md +++ b/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml Module Name: FailoverClusters -ms.date: 09/11/2024 +ms.date: 04/24/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/test-workgroupcluster?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Test-WorkgroupCluster From 7d243e86c9f057f4b5a412c6e01c9328f4eba411 Mon Sep 17 00:00:00 2001 From: Jason Gerend <7906263+JasonGerend@users.noreply.github.com> Date: Fri, 25 Apr 2025 14:21:01 -0700 Subject: [PATCH 7/8] Adding a prompts folder to be ignored for now --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index e0de607b88..8cd5e2f6d7 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,5 @@ common/ *.db .openpublishing.buildcore.ps1 + +.github/prompts/ From 0f8a9fdd245cdf4a851010a56d462e5e5ec98842 Mon Sep 17 00:00:00 2001 From: Jason Gerend <7906263+JasonGerend@users.noreply.github.com> Date: Fri, 25 Apr 2025 15:02:33 -0700 Subject: [PATCH 8/8] Little edits --- .../Add-WorkgroupClusterNode.md | 28 +++++++++++++------ 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md b/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md index 922f936367..27d38d6137 100644 --- a/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md +++ b/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md @@ -2,15 +2,17 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.Adless.PowerShell.psm1-help.xml Module Name: FailoverClusters -ms.date: 04/24/2025 +ms.date: 04/25/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-workgroupclusternode?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Add-WorkgroupClusterNode +ai-usage: ai-generated --- # Add-WorkgroupClusterNode ## SYNOPSIS + Adds a node to a workgroup cluster. ## SYNTAX @@ -23,28 +25,33 @@ Add-WorkgroupClusterNode [-Node] [-Credentials] [-Na ## DESCRIPTION -The `Add-WorkgroupClusterNode` cmdlet adds a node to a workgroup cluster. This cmdlet allows you to expand an existing workgroup cluster by adding a new node, specifying the required credentials and authentication method. The node can be added with or without shared storage, depending on your configuration. +The `Add-WorkgroupClusterNode` cmdlet adds a node to a workgroup cluster. This cmdlet lets you +expand an existing workgroup cluster by adding a new node, specifying the required credentials and +authentication method. The node can be added with or without shared storage, depending on your +configuration. ## EXAMPLES -### EXAMPLE 1 +### Example 1: Add a node to a workgroup cluster + +This example adds `Node3` to the cluster whose membership is comprised of `Node1` and `Node2`. ```powershell -$params = @{ +$parameters = @{ Node = @("Node1", "Node2") Credentials = @($cred1, $cred2) Name = "Node3" Credential = $cred3 } -Add-WorkgroupClusterNode @params +Add-WorkgroupClusterNode @parameters ``` -This example adds `Node3` to the cluster whose membership is comprised of `Node1` and `Node2`. - ## PARAMETERS ### -AuthenticationMethod + Specifies the authentication method to use when adding the node to the workgroup cluster. Acceptable values are: + - `Certificates`: Uses certificate-based authentication for secure communication between nodes. - `NoCertificates`: Uses local user accounts and passwords for authentication without certificates. @@ -183,21 +190,26 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### System.String[] + You can pipe an array of node names to this cmdlet. ### System.Management.Automation.PSCredential[] + You can pipe an array of credentials to this cmdlet. ### System.String + You can pipe the name of the node to be added. ### System.Management.Automation.PSCredential + You can pipe the credential for the node to be added. ## OUTPUTS ### None -This cmdlet does not generate any output. It performs the operation of adding a node to a workgroup cluster. + +This cmdlet doesn't generate any output. It performs the operation of adding a node to a workgroup cluster. ## NOTES