COMMAND EVERYTHING.

Add-ClusterGenericServiceRole

Configures high availability for a service that wasn't originally designed to run in a failover cluster.

Windows Server · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft FailoverClusters reference: Configures high availability for a service that wasn't originally designed to run in a failover cluster. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Add-ClusterGenericServiceRole -ServiceName <String> [-CheckpointKey <StringCollection>]
 [-Storage <StringCollection>] [-StaticAddress <StringCollection>]
 [-IgnoreNetwork <StringCollection>] [[-Name] <String>] [-Wait <Int32>] [-InputObject <PSObject>]
 [-Cluster <String>] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Add-ClusterGenericServiceRole. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / FailoverClusters · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-CheckpointKey: Specifies a comma-separated list of registry checkpoint keys to add for this highly available generic application. All registry paths are relative to HKEY_LOCAL_MACHINE.
-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.
-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.
-InputObject: Specifies the cluster on which to create the highly available service.
-Name: Specifies the name of the highly available service to create.
-ServiceName (required): Specifies the service name to use for the highly available service.
-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.
-Storage: Specifies the cluster disk resource to be added to the created highly available service.
-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.

Prerequisites

Windows with the FailoverClusters module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Configure a service that uses default values

Add-ClusterGenericServiceRole -ServiceName "Service1"

This example configures Service1 as a generic clustered service, using defaults for the name and IP address, and doesn't assign a disk. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/FailoverClusters/Add-ClusterGenericServiceRole.md

https://learn.microsoft.com/powershell/module/failoverclusters/add-clustergenericservicerole?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands

Add-CauClusterRole

Add-ClusterCheckpoint

Get-FsrmAdrSetting

Clear-HgsServer