The Add-ClusterGenericServiceRole cmdlet configures high availability for a service that was not originally designed to run in a failover cluster.
The cluster software will start the service, then periodically query the Service Controller, which is a feature of the operating system, to determine whether the service appears to be running.
If so, then it is presumed to be online, and will not be restarted or failed over.
Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.
Examples
Example 1: Configure a service that uses default values
PS C:\> Add-ClusterGenericServiceRole -ServiceName "Service1"
Name OwnerNode State
---- --------- -----
cluster1GenSvc node1 Online
This example configures Service1 as a generic clustered service, using defaults for the name and IP address, and does not assign a disk.
Example 2: Configure a service that uses default values and a specified disk
PS C:\> Add-ClusterGenericServiceRole -ServiceName "Service1" -Storage "Cluster Disk 6"
Name OwnerNode State
---- --------- -----
cluster1GenSvc node1 Online
This example configures Service1 as a generic clustered service using Cluster Disk 6, and assigns defaults for the name and IP address.
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.
Parameter properties
Type:
StringCollection
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-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.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-IgnoreNetwork
Specifies one or more networks to ignore when running the cmdlet.
Networks with DHCP enabled are always included, but other networks need a static address to be specified using the StaticAddress parameter or should be explicitly ignored with this IgnoreNetwork parameter.
Parameter properties
Type:
StringCollection
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-InputObject
Specifies the cluster on which to create the highly available service.
Parameter properties
Type:
PSObject
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Name
Specifies the name of the highly available service to create.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
0
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ServiceName
Specifies the service name to use for the highly available service.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-StaticAddress
Specifies one or more static addresses to use when running the cmdlet.
Networks with DHCP enabled are always included, but other networks need a static address to be specified using the StaticAddress parameter or should be explicitly ignored with this IgnoreNetwork parameter.
Parameter properties
Type:
StringCollection
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Storage
Specifies the cluster disk resource to be added to the created highly available service.
Parameter properties
Type:
StringCollection
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Wait
Specifies the time in seconds to wait for the cmdlet.
If the Wait parameter is not specified, then the cmdlet waits for completion.
If -Wait 0 is specified, then the call is initiated and the cmdlet returns without waiting.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.