Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-ClusterGenericServiceRole

Add-ClusterGenericServiceRole

microsoft.failoverclusters.powershell.dll

Synopsis

Configures high availability for a service that was not originally designed to run in a failover cluster.

Syntax

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

Detailed Description

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 (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.

Parameters

-CheckpointKey <StringCollection>

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.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Cluster <String>

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.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-IgnoreNetwork <StringCollection>

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.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <PSObject>

Specifies the cluster on which to create the highly available service.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Name <String>

Specifies the name of the highly available service to create.

Aliases

None

Required?

false

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-ServiceName <String>

Specifies the service name to use for the highly available service.

Aliases

None

Required?

true

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-StaticAddress <StringCollection>

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.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Storage <StringCollection>

Specifies the cluster disk resource to be added to the created highly available service.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Wait <Int32>

Specifies the time in seconds to wait for the cmdlet. If the <maml:system>Wait</maml:system> parameter is not specified, then the cmdlet waits for completion. If <maml:codeInline>-Wait 0</maml:codeInline> is specified, then the call is initiated and the cmdlet returns without waiting.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.FailoverClusters.PowerShell.Cluster

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Notes

None

Examples

Example 1

This example configures Service1 as a generic clustered service, using defaults for the name and IP address, and does not assign a disk.

PS C:\>Add-ClusterGenericServiceRole -ServiceName Service1
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1GenSvc             node1                              Online 

Example 2

This example configures Service1 as a generic clustered service using Cluster Disk 6, and assigns defaults for the name and IP address.

PS C:\>Add-ClusterGenericServiceRole -ServiceName Service1 -Storage "Cluster Disk 6"
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1GenSvc             node1                              Online 

Online Version
Add-ClusterGenericApplicationRole
Add-ClusterGenericScriptRole
Get-ClusterGroup
Move-ClusterGroup
Remove-ClusterGroup
Start-ClusterGroup
Stop-ClusterGroup