diff --git a/docset/winserver2022-ps/activedirectory/New-ADFineGrainedPasswordPolicy.md b/docset/winserver2022-ps/activedirectory/New-ADFineGrainedPasswordPolicy.md index 6517995ce1..6ccea5fdbf 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADFineGrainedPasswordPolicy.md +++ b/docset/winserver2022-ps/activedirectory/New-ADFineGrainedPasswordPolicy.md @@ -71,13 +71,6 @@ PS C:\> New-ADFineGrainedPasswordPolicy -Instance $TemplatePSO -Name "AdminsPSO" This example creates two new fine-grained password policy objects using a template object. -### Example 3: Create a fine-grained password policy with manual account unlock -```powershell -PS C:\> New-ADFineGrainedPasswordPolicy -Name "ManualUnlockPSO" -Precedence 500 -ComplexityEnabled $true -Description "Manual Unlock Password Policy" -DisplayName "Manual Unlock PSO" -LockoutDuration "00:00:00" -LockoutObservationWindow "00:00:00" -LockoutThreshold 3 -``` - -This command creates a fine-grained password policy object named ManualUnlockPSO that would require manual unlock of accounts by the administrator. - ## PARAMETERS ### -AuthType @@ -275,6 +268,10 @@ The LDAP display name (**ldapDisplayName**) of this property is **msDS-lockoutOb The lockout observation window must be smaller than or equal to the lockout duration for a password policy. Use the *LockoutDuration* parameter to set the lockout duration time. +> [!NOTE] +> Setting the lockout observation window to 0 effectively means that the window is too short to +> observe more than one password attempt, therefore the account will never be locked out. + Specify the time interval in the following format: `D:H:M:S.F` diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeploymentInstall-ADDSForest mf similarity index 100% rename from docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md rename to docset/winserver2022-ps/addsdeploymentInstall-ADDSForest mf diff --git a/docset/winserver2022-ps/dism/Add-WindowsPackage.md b/docset/winserver2022-ps/dism/Add-WindowsPackage.md index 1f6e1dd32b..ce8bfaf4b0 100644 --- a/docset/winserver2022-ps/dism/Add-WindowsPackage.md +++ b/docset/winserver2022-ps/dism/Add-WindowsPackage.md @@ -275,6 +275,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES +**Checkpoint cumulative updates** + +Starting with Windows 11, version 24H2, the latest cumulative update may have a prerequisite cumulative update that is required to be installed first. To install these checkpoint cumulative updates, call Add-WindowsPackage with the target cumulative update. The folder from -PackagePath will be used to discover and install one or more checkpoints as needed. Only the target cumulative update and any prerequisite checkpoint cumulative updates should be in the -PackagePath folder. Cumulative update packages with a revision less than or equal to the target cumulative update will be processed. + ## RELATED LINKS [Get-WindowsPackage](./Get-WindowsPackage.md) diff --git a/docset/winserver2022-ps/startlayout/Import-StartLayout.md b/docset/winserver2022-ps/startlayout/Import-StartLayout.md index f874fd48ce..6a2b8e179e 100644 --- a/docset/winserver2022-ps/startlayout/Import-StartLayout.md +++ b/docset/winserver2022-ps/startlayout/Import-StartLayout.md @@ -16,12 +16,12 @@ Imports the layout of the Start into a mounted Windows image. ## SYNTAX ### Path -``` +```powershell Import-StartLayout [-LayoutPath] [-MountPath] [-WhatIf] [-Confirm] [] ``` ### LiteralPath -``` +```powershell Import-StartLayout -LayoutLiteralPath -MountLiteralPath [-WhatIf] [-Confirm] [] ``` @@ -36,6 +36,8 @@ You must have administrator rights to import a layout. In Windows 10, the Export-StartLayout cmdlet exports layouts as .xml files, and the **Import-StartLayout** cmdlet imports only .xml files. +> [!CAUTION] +> The Import-StartLayout cmdlet is deprecated in Windows 11. It has no effect on either Start or Taskbar layout. To configure the Start layout in Windows 11, see [Customize the Windows 11 Start layout](https://learn.microsoft.com/en-us/windows-hardware/customize/desktop/customize-the-windows-11-start-menu). To configure Taskbar layout in Windows 11, see [Customize the Taskbar](https://learn.microsoft.com/en-us/windows-hardware/customize/desktop/customize-the-windows-11-taskbar). ## EXAMPLES ### Example 1: Import a layout into a Windows image diff --git a/docset/winserver2025-ps/activedirectory/New-ADFineGrainedPasswordPolicy.md b/docset/winserver2025-ps/activedirectory/New-ADFineGrainedPasswordPolicy.md index 279660c38a..57aa2cef51 100644 --- a/docset/winserver2025-ps/activedirectory/New-ADFineGrainedPasswordPolicy.md +++ b/docset/winserver2025-ps/activedirectory/New-ADFineGrainedPasswordPolicy.md @@ -71,13 +71,6 @@ PS C:\> New-ADFineGrainedPasswordPolicy -Instance $TemplatePSO -Name "AdminsPSO" This example creates two new fine-grained password policy objects using a template object. -### Example 3: Create a fine-grained password policy with manual account unlock -```powershell -PS C:\> New-ADFineGrainedPasswordPolicy -Name "ManualUnlockPSO" -Precedence 500 -ComplexityEnabled $true -Description "Manual Unlock Password Policy" -DisplayName "Manual Unlock PSO" -LockoutDuration "00:00:00" -LockoutObservationWindow "00:00:00" -LockoutThreshold 3 -``` - -This command creates a fine-grained password policy object named ManualUnlockPSO that would require manual unlock of accounts by the administrator. - ## PARAMETERS ### -AuthType @@ -275,6 +268,10 @@ The LDAP display name (**ldapDisplayName**) of this property is **msDS-lockoutOb The lockout observation window must be smaller than or equal to the lockout duration for a password policy. Use the *LockoutDuration* parameter to set the lockout duration time. +> [!NOTE] +> Setting the lockout observation window to 0 effectively means that the window is too short to +> observe more than one password attempt, therefore the account will never be locked out. + Specify the time interval in the following format: `D:H:M:S.F` diff --git a/docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md b/docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md new file mode 100644 index 0000000000..a8b2c62334 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md @@ -0,0 +1,167 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +ms.date: 08/28/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Add-ClusterExcludedAdapter +--- + +# Add-ClusterExcludedAdapter + +## SYNOPSIS +Adds a network adapter to the list of excluded adapters. + +## SYNTAX + +``` +Add-ClusterExcludedAdapter -ExclusionType -ExclusionValue + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +The `Add-ClusterExcludedAdapter` cmdlet adds a network adapter to a list of network adapters that +should be excluded from use by the Failover Cluster. By default, the cluster will use all available +network adapters, but in some cases you may want to reserve certain adapters as backup or +management, such as Dell iDRAC or HPE iLO. + +## EXAMPLES + +### Example 1 + +```powershell +Add-ClusterExcludedAdapter -ExclusionType "IPPrefix" -ExclusionValue "10.10.20.25" +``` + +This example excludes the network adapter based on the IP Address `10.10.20.25` from use by the +cluster. + +## PARAMETERS + +### -AsJob + +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionType + +Specifies the type of exclusion to add to the cluster. Acceptable values are: + +- `IPPrefix`: Excludes a network adapter based on its IP address. +- `Description`: Excludes a network adapter based on its description. +- `FriendlyName`: Excludes a network adapter based on its friendly name. + +```yaml +Type: AdapterExclusionType +Parameter Sets: (All) +Aliases: +Accepted values: IPPrefix, Description, FriendlyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionValue + +Specifies the value to use for the exclusion. The value of this parameter depends on the value of +the `-ExclusionType` parameter. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If +this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum +throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md) + +[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md) + +[Repair-ClusterNameAccount](repair-clusternameaccount.md) + +[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md) diff --git a/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md b/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md new file mode 100644 index 0000000000..501c03b6b4 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md @@ -0,0 +1,182 @@ +--- +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 +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 +--- + +# Add-WorkgroupClusterNode + +## SYNOPSIS +Adds a node to a workgroup cluster. + +## SYNTAX + +``` +Add-WorkgroupClusterNode [-Node] [-Credentials] [-Name] + [-Credential] [-NoStorage] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION + +The `Add-WorkgroupClusterNode` cmdlet adds a node to a workgroup cluster. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +$params = @{ + Node = @("Node1", "Node2") + Credentials = @($cred1, $cred2) + Name = "Node3" + Credential = $cred3 +} +Add-WorkgroupClusterNode @params +``` + +This example adds `Node3` to the cluster whose membership is comprised of `Node1` and `Node2`. + +## PARAMETERS + +### -Node + +An array of nodes to be added to the cluster. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +The name of the node to be added. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +The credential for the node to be added. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoStorage + +Specifies that shared storage is ignored for the workgroup cluster node. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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 +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-WorkgroupCluster](new-workgroupcluster.md) + +[Remove-WorkgroupCluster](remove-workgroupcluster.md) + +[Remove-WorkgroupClusterNode](remove-workgroupclusternode.md) + +[Set-WorkgroupClusterRemotingConfiguration](set-workgroupclusterremotingconfiguration.md) + +[Test-WorkgroupCluster](test-workgroupcluster.md) + +[Test-WorkgroupClusterRemoting](test-workgroupclusterremoting.md) diff --git a/docset/winserver2025-ps/failoverclusters/Get-ClusterCredential.md b/docset/winserver2025-ps/failoverclusters/Get-ClusterCredential.md new file mode 100644 index 0000000000..e3548d6064 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Get-ClusterCredential.md @@ -0,0 +1,72 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +ms.date: 09/17/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustercredential?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-ClusterCredential +--- + +# Get-ClusterCredential + +## SYNOPSIS +Retrieves the credentials for a specified node in a failover cluster. + +## SYNTAX + +``` +Get-ClusterCredential [[-NodeName] ] [] +``` + +## DESCRIPTION + +The `Get-ClusterCredential` cmdlet retrieves the credentials for a specified node in a failover +cluster. + +## EXAMPLES + +### Example 1 + +```powershell +Get-ClusterCredential -NodeName "Node01" +``` + +This example retrieves the credentials for a node named `Node01` in the failover cluster. + +## PARAMETERS + +### -NodeName + +Specifies the name of the node for which to retrieve the credentials. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.Management.Automation.PSCredential + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2025-ps/failoverclusters/Get-ClusterExcludedAdapter.md b/docset/winserver2025-ps/failoverclusters/Get-ClusterExcludedAdapter.md new file mode 100644 index 0000000000..a04d02e84d --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Get-ClusterExcludedAdapter.md @@ -0,0 +1,150 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +ms.date: 08/28/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-ClusterExcludedAdapter +--- + +# Get-ClusterExcludedAdapter + +## SYNOPSIS +Retrieves a network adapter from the list of excluded adapters. + +## SYNTAX + +``` +Get-ClusterExcludedAdapter -ExclusionType [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +The `Get-ClusterExcludedAdapter` cmdlet retrieves a network adapter from a list of network adapters +that should be excluded from use by the Failover Cluster. By default, the cluster will use all +available network adapters, but in some cases you may want to reserve certain adapters as backup or +management, such as Dell iDRAC or HPE iLO. + +## EXAMPLES + +### Example 1 + +```powershell +Get-ClusterExcludedAdapter -ExclusionType "FriendlyName" +``` + +This example retrieves a list of network adapters that have been excluded from use by the cluster +based on the friendly name. + +## PARAMETERS + +### -AsJob + +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionType + +Specifies the type of exclusion to retrieve from the cluster. Acceptable values are: + +- `IPPrefix`: Excludes a network adapter based on its IP address. +- `Description`: Excludes a network adapter based on its description. +- `FriendlyName`: Excludes a network adapter based on its friendly name. + +```yaml +Type: AdapterExclusionType +Parameter Sets: (All) +Aliases: +Accepted values: IPPrefix, Description, FriendlyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If +this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum +throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.String[] + +## NOTES + +## RELATED LINKS + +[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md) + +[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md) + +[Repair-ClusterNameAccount](repair-clusternameaccount.md) + +[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md) diff --git a/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md new file mode 100644 index 0000000000..1c4c0fbd37 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md @@ -0,0 +1,286 @@ +--- +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 +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 +--- + +# New-WorkgroupCluster + +## SYNOPSIS +Creates a new workgroup cluster. + +## SYNTAX + +``` +New-WorkgroupCluster [[-Node] ] [[-Credentials] ] [[-Name] ] + [[-StaticAddress] ] [[-IgnoreNetwork] ] + [[-ManagementPointNetworkType] ] + [[-AdministrativeAccessPoint] ] [-NoStorage] [-S2D] [-Force] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION + +The `New-WorkgroupCluster` cmdlet creates a new workgroup cluster. + +## EXAMPLES + +### EXAMPLE 1 + +```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 + +### -Node + +An array of nodes to be included in the cluster. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: @() +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 +``` + +### -Name + +The name of the workgroup cluster. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: 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. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: 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. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: 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`. + +```yaml +Type: AdminAccessPointResType +Parameter Sets: (All) +Aliases: +Accepted values: Automatic, Singleton, Distributed + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: AdminAccessPoint +Parameter Sets: (All) +Aliases: +Accepted values: None, Dns + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoStorage + +Specifies that shared storage is ignored for the workgroup cluster node. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -S2D + +Specifies whether to enable Storage Spaces Direct when creating the workgroup cluster. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the command to run without asking for user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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 +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Add-WorkgroupClusterNode](add-workgroupclusternode.md) + +[Remove-WorkgroupCluster](remove-workgroupcluster.md) + +[Remove-WorkgroupClusterNode](remove-workgroupclusternode.md) + +[Set-WorkgroupClusterRemotingConfiguration](set-workgroupclusterremotingconfiguration.md) + +[Test-WorkgroupCluster](test-workgroupcluster.md) + +[Test-WorkgroupClusterRemoting](test-workgroupclusterremoting.md) diff --git a/docset/winserver2025-ps/failoverclusters/Remove-ClusterExcludedAdapter.md b/docset/winserver2025-ps/failoverclusters/Remove-ClusterExcludedAdapter.md new file mode 100644 index 0000000000..ac93ba27f4 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Remove-ClusterExcludedAdapter.md @@ -0,0 +1,167 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +ms.date: 08/28/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Remove-ClusterExcludedAdapter +--- + +# Remove-ClusterExcludedAdapter + +## SYNOPSIS +Removes a network adapter from the list of excluded adapters. + +## SYNTAX + +``` +Remove-ClusterExcludedAdapter -ExclusionType -ExclusionValue + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +The `Remove-ClusterExcludedAdapter` cmdlet removes a network adapter from a list of network +adapters that should be excluded from use by the Failover Cluster. By default, the cluster will use +all available network adapters, but in some cases you may want to reserve certain adapters as +backup or management, such as Dell iDRAC or HPE iLO. + +## EXAMPLES + +### Example 1 + +```powershell +Remove-ClusterExcludedAdapter -ExclusionType "IPPrefix" -ExclusionValue "10.10.20.25" +``` + +This example removes the network adapter based on the IP Address `10.10.20.25` from the list of +excluded adapters. + +## PARAMETERS + +### -AsJob + +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionType + +Specifies the type of exclusion to remove from the cluster. Acceptable values are: + +- `IPPrefix`: Excludes a network adapter based on its IP address. +- `Description`: Excludes a network adapter based on its description. +- `FriendlyName`: Excludes a network adapter based on its friendly name. + +```yaml +Type: AdapterExclusionType +Parameter Sets: (All) +Aliases: +Accepted values: IPPrefix, Description, FriendlyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionValue + +Specifies the value to use for the exclusion. The value of this parameter depends on the value of +the `-ExclusionType` parameter. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If +this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum +throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md) + +[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md) + +[Repair-ClusterNameAccount](repair-clusternameaccount.md) + +[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md) diff --git a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md new file mode 100644 index 0000000000..f08fbaf834 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md @@ -0,0 +1,147 @@ +--- +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 +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 +--- + +# Remove-WorkgroupCluster + +## SYNOPSIS +Removes a workgroup cluster. + +## SYNTAX + +``` +Remove-WorkgroupCluster [[-Node] ] [[-Credentials] ] [-Force] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION + +The `Remove-WorkgroupCluster` cmdlet removes a workgroup cluster. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Remove-WorkgroupCluster -Node "Node1", "Node2" -Credentials $cred1, $cred2 +``` + +This example removes the cluster from both `Node1` and `Node2`. + +If communication is lost with a node or the membership isn't complete, the cluster might not +be removed and manual cleanup may be needed. + +## PARAMETERS + +### -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 +``` + +### -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 +``` + +### -Force + +Forces the command to run without asking for user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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 +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Add-WorkgroupClusterNode](add-workgroupclusternode.md) + +[New-WorkgroupCluster](new-workgroupcluster.md) + +[Remove-WorkgroupClusterNode](remove-workgroupclusternode.md) + +[Set-WorkgroupClusterRemotingConfiguration](set-workgroupclusterremotingconfiguration.md) + +[Test-WorkgroupCluster](test-workgroupcluster.md) + +[Test-WorkgroupClusterRemoting](test-workgroupclusterremoting.md) diff --git a/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md new file mode 100644 index 0000000000..e3e63f393b --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md @@ -0,0 +1,235 @@ +--- +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 +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 +--- + +# Remove-WorkgroupClusterNode + +## SYNOPSIS +Removes a node from a workgroup cluster. + +## SYNTAX + +``` +Remove-WorkgroupClusterNode [-Node] [-Credentials] [-Name] + [[-Wait] ] [-IgnoreStorageConnectivityLoss] [-CleanupDisks] [-Force] [-Confirm] [-WhatIf] + [] +``` + +## 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 +[Remove-ClusterNode](/powershell/module/failoverclusters/remove-clusternode) cmdlet. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Remove-WorkgroupClusterNode -Node "Node1", "Node2" -Credentials $cred1, $cred2 -Name $Node2 +``` + +This example removes `Node2` from the cluster membership. + +### EXAMPLE 2 + +```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 + +### -Node + +An array of nodes in the workgroup cluster. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +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: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +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: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CleanupDisks + +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: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the command to run without asking for user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreStorageConnectivityLoss + +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 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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 +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Add-WorkgroupClusterNode](add-workgroupclusternode.md) + +[Clear-ClusterNode](clear-clusternode.md) + +[New-WorkgroupCluster](new-workgroupcluster.md) + +[Remove-WorkgroupCluster](remove-workgroupcluster.md) + +[Set-WorkgroupClusterRemotingConfiguration](set-workgroupclusterremotingconfiguration.md) + +[Test-WorkgroupCluster](test-workgroupcluster.md) + +[Test-WorkgroupClusterRemoting](test-workgroupclusterremoting.md) diff --git a/docset/winserver2025-ps/failoverclusters/Repair-ClusterNameAccount.md b/docset/winserver2025-ps/failoverclusters/Repair-ClusterNameAccount.md new file mode 100644 index 0000000000..00e5a2d80b --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Repair-ClusterNameAccount.md @@ -0,0 +1,156 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +ms.date: 08/28/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/repair-clusternameaccount?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Repair-ClusterNameAccount +--- + +# Repair-ClusterNameAccount + +## SYNOPSIS +Repairs the Cluster Name Account and ensures that the cluster continues to function properly. + +## SYNTAX + +### InputObject (Default) + +``` +Repair-ClusterNameAccount [-Credentials ] [-Domain ] [-InputObject ] + [-Cluster ] [] +``` + +### Credentials + +``` +Repair-ClusterNameAccount [-Credentials ] [-Domain ] [-Cluster ] + [] +``` + +## DESCRIPTION + +The `Repair-ClusterNameAccount` cmdlet repairs or updates the Cluster Name Account used for +authentication and authorization on a Failover Cluster. The Cluster Name Account is used to create +Highly Available applications or Virtual Computer Objects (VCOs) in the cluster. + +To learn more about cluster accounts in domain environments, see +[Configuring cluster accounts in Active Directory](/windows-server/failover-clustering/configure-ad-accounts). + +## EXAMPLES + +### Example 1 + +```powershell +Repair-ClusterNameAccount -Cluster "Cluster01" +``` + +This example repairs or updates the Cluster Name Account for the cluster named `Cluster01`. + +### Example 2 + +```powershell +$cred = Get-Credential +Repair-ClusterNameAccount -Cluster "Cluster01" -Credentials $cred -Domain "contoso.com" +``` + +This example repairs or updates the Cluster Name Account for the cluster named `Cluster01` using +the specified credentials and domain. The `Get-Credential` cmdlet is used to create a PSCredential +object for the `-Credentials` parameter. + +## PARAMETERS + +### -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 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credentials + +Specifies the credentials that this cmdlet uses when it connects to Active Directory Domain +Services. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies the name of the domain in which to repair the cluster name account. This should be the +fully qualified domain name (FQDN) of the domain that the cluster is in. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Specifies the cluster name account to repair. + +```yaml +Type: PSObject +Parameter Sets: InputObject +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md) + +[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md) + +[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md) + +[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md) diff --git a/docset/winserver2025-ps/failoverclusters/Set-ClusterExcludedAdapter.md b/docset/winserver2025-ps/failoverclusters/Set-ClusterExcludedAdapter.md new file mode 100644 index 0000000000..354b7bd1d5 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Set-ClusterExcludedAdapter.md @@ -0,0 +1,168 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +ms.date: 08/28/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Set-ClusterExcludedAdapter +--- + +# Set-ClusterExcludedAdapter + +## SYNOPSIS +Sets a network adapter to the list of excluded adapters. + +## SYNTAX + +``` +Set-ClusterExcludedAdapter -ExclusionType -ExclusionValue + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +The `Set-ClusterExcludedAdapter` cmdlet configures a network adapter in a list of network adapters +that should be excluded from use by the Failover Cluster. By default, the cluster will use all +available network adapters, but in some cases you may want to reserve certain adapters as backup or +management, such as Dell iDRAC or HPE iLO. + +## EXAMPLES + +### Example 1 + +```powershell +Set-ClusterExcludedAdapter -ExclusionType "Description" -ExclusionValue "Node-1-FL1","Node-1-FL2" +``` + +This example sets the list of excluded network adapters for the cluster. After running this +command, the cluster will no longer use `Node-1-FL1` or `Node-1-FL2` for cluster communications, +ensuring that they are available for management or backup purposes. + +## PARAMETERS + +### -AsJob + +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionType + +Specifies the type of exclusion to remove from the cluster. Acceptable values are: + +- `IPPrefix`: Excludes a network adapter based on its IP address. +- `Description`: Excludes a network adapter based on its description. +- `FriendlyName`: Excludes a network adapter based on its friendly name. + +```yaml +Type: AdapterExclusionType +Parameter Sets: (All) +Aliases: +Accepted values: IPPrefix, Description, FriendlyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionValue + +Specifies the value to use for the exclusion. The value of this parameter depends on the value of +the `-ExclusionType` parameter. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If +this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum +throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md) + +[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md) + +[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md) + +[Repair-ClusterNameAccount](repair-clusternameaccount.md) diff --git a/docset/winserver2025-ps/failoverclusters/Set-WorkgroupClusterRemotingConfiguration.md b/docset/winserver2025-ps/failoverclusters/Set-WorkgroupClusterRemotingConfiguration.md new file mode 100644 index 0000000000..99b29e07f6 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Set-WorkgroupClusterRemotingConfiguration.md @@ -0,0 +1,69 @@ +--- +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 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-workgroupclusterremotingconfiguration?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Set-WorkgroupClusterRemotingConfiguration +--- + +# Set-WorkgroupClusterRemotingConfiguration + +## SYNOPSIS +Configures the remote management settings for a failover cluster that is part of a workgroup. + +## SYNTAX + +``` +Set-WorkgroupClusterRemotingConfiguration [] +``` + +## DESCRIPTION + +The `Set-WorkgroupClusterRemotingConfiguration` cmdlet configures the remote management settings for +a failover cluster that is part of a workgroup. + +## EXAMPLES + +### Example 1 + +```powershell +Set-WorkgroupClusterRemotingConfiguration -Verbose +``` + +This example displays detailed information about the current workgroup cluster remoting +configuration. + +## PARAMETERS + +### 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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Add-WorkgroupClusterNode](add-workgroupclusternode.md) + +[New-WorkgroupCluster](new-workgroupcluster.md) + +[Remove-WorkgroupCluster](remove-workgroupcluster.md) + +[Remove-WorkgroupClusterNode](remove-workgroupclusternode.md) + +[Test-WorkgroupCluster](test-workgroupcluster.md) + +[Test-WorkgroupClusterRemoting](test-workgroupclusterremoting.md) diff --git a/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md b/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md new file mode 100644 index 0000000000..0d68dd5b64 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md @@ -0,0 +1,294 @@ +--- +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 +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 +--- + +# Test-WorkgroupCluster + +## SYNOPSIS +Tests the configuration of a workgroup cluster. + +## SYNTAX + +``` +Test-WorkgroupCluster [[-Node] ] [[-Credentials] ] [[-Disk] ] + [[-Pool] ] [[-ReportName] ] [[-Include] ] [[-Ignore] ] + [-Force] [[-Cluster] ] [-Confirm] [-WhatIf] [-Destination] [] +``` + +## DESCRIPTION + +The `Test-WorkgroupCluster` function tests the configuration of a workgroup cluster. The rest of +the parameters will be forwarded to the `Test-Cluster` function. Please refer to the documentation +for the [Test-Cluster](/powershell/module/failoverclusters/test-cluster) cmdlet. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Test-WorkgroupCluster -Node "Node1", "Node2" -Credentials $cred1, $cred2 +``` + +This example tests the configuration of a workgroup cluster with `Node1` and `Node2` using the +credentials in `$cred1` and `$cred2`, and additional parameters. + +## PARAMETERS + +### -Node + +An array of nodes in the workgroup cluster. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: @() +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: 3 +Default value: None +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 +is assigned to a clustered role or Cluster Shared Volume, you must also specify the **Force** +parameter to take the disk offline for the duration of the storage tests. Otherwise, the specified +disk must be offline before the cmdlet is run. + +If the **Disk** parameter isn't specified, storage tests run on all disks that are available for +use in the cluster or that are in the cluster resource offline or failed state. + +Acceptable values are: + +- **Int32, Int64, Uint32, or Uint64**: A number that represents a master boot record (MBR) + signature of the disk. +- **System.String**: A string that represents a master boot record (MBR) signature of the disk, + hexadecimal format is supported, or a string that represents the GUID of a GPT disk. +- **ClusterResource**: A cluster resource object that represents a clustered disk. +- **CimInstance#MSFT_Disk**: An object returned from `Get-Disk`, from the Windows PowerShell storage + module. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +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: + +- **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: Object[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportName + +Specifies the name of the test report to generate. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Include + +Specifies which tests or category of tests to include during the validation test run. Only the tests +or category of tests specified will run. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ignore + +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[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the command to run without asking for user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: False +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 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +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: 11 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +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, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Add-WorkgroupClusterNode](add-workgroupclusternode.md) + +[New-WorkgroupCluster](new-workgroupcluster.md) + +[Remove-WorkgroupCluster](remove-workgroupcluster.md) + +[Remove-WorkgroupClusterNode](remove-workgroupclusternode.md) + +[Set-WorkgroupClusterRemotingConfiguration](set-workgroupclusterremotingconfiguration.md) + +[Test-WorkgroupClusterRemoting](test-workgroupclusterremoting.md) diff --git a/docset/winserver2025-ps/failoverclusters/Test-WorkgroupClusterRemoting.md b/docset/winserver2025-ps/failoverclusters/Test-WorkgroupClusterRemoting.md new file mode 100644 index 0000000000..25a1a2be22 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Test-WorkgroupClusterRemoting.md @@ -0,0 +1,98 @@ +--- +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 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/test-workgroupclusterremoting?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Test-WorkgroupClusterRemoting +--- + +# Test-WorkgroupClusterRemoting + +## SYNOPSIS +Tests if remoting is configured on all nodes. + +## SYNTAX + +``` +Test-WorkgroupClusterRemoting [[-Node] ] [[-Credentials] ] + [] +``` + +## DESCRIPTION + +The `Test-WorkgroupClusterRemoting` function tests if remoting is configured on all nodes. It also +verifies if CredSSP is configured. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Test-WorkgroupClusterRemoting -Node "Node1", "Node2" -Credentials $cred1, $cred2 +``` + +This example tests if remoting is configured on `Node1` and `Node2` using the credentials in +`$cred1` and `$cred2`. + +## PARAMETERS + +### -Node + +An array of nodes to test remoting on. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: @() +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: 3 +Default value: None +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](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Add-WorkgroupClusterNode](add-workgroupclusternode.md) + +[New-WorkgroupCluster](new-workgroupcluster.md) + +[Remove-WorkgroupCluster](remove-workgroupcluster.md) + +[Remove-WorkgroupClusterNode](remove-workgroupclusternode.md) + +[Set-WorkgroupClusterRemotingConfiguration](set-workgroupclusterremotingconfiguration.md) + +[Test-WorkgroupCluster](test-workgroupcluster.md) diff --git a/docset/winserver2025-ps/startlayout/Import-StartLayout.md b/docset/winserver2025-ps/startlayout/Import-StartLayout.md index e26c8f0d95..47479bd6be 100644 --- a/docset/winserver2025-ps/startlayout/Import-StartLayout.md +++ b/docset/winserver2025-ps/startlayout/Import-StartLayout.md @@ -16,12 +16,12 @@ Imports the layout of the Start into a mounted Windows image. ## SYNTAX ### Path -``` +```powershell Import-StartLayout [-LayoutPath] [-MountPath] [-WhatIf] [-Confirm] [] ``` ### LiteralPath -``` +```powershell Import-StartLayout -LayoutLiteralPath -MountLiteralPath [-WhatIf] [-Confirm] [] ``` @@ -36,6 +36,9 @@ You must have administrator rights to import a layout. In Windows 10, the Export-StartLayout cmdlet exports layouts as .xml files, and the **Import-StartLayout** cmdlet imports only .xml files. +> [!CAUTION] +> The Import-StartLayout cmdlet is deprecated in Windows 11. It has no effect on either Start or Taskbar layout. To configure the Start layout in Windows 11, see [Customize the Windows 11 Start layout](https://learn.microsoft.com/en-us/windows-hardware/customize/desktop/customize-the-windows-11-start-menu). To configure Taskbar layout in Windows 11, see [Customize the Taskbar](https://learn.microsoft.com/en-us/windows-hardware/customize/desktop/customize-the-windows-11-taskbar). + ## EXAMPLES ### Example 1: Import a layout into a Windows image