Add-ClusterGenericServiceRole

  • Article

Add-ClusterGenericServiceRole

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

Syntax

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

  • InputObject

  • ServiceName

  • Name

  • CheckpointKey

  • Cluster

  • IgnoreNetwork

  • StaticAddress

  • Storage

  • Wait

Detailed Description

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, it is presumed to be online, and will not be restarted or failed over.

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 HKLM\.

Default Value: **

Data Type: StringCollection

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Cluster

Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

IgnoreNetwork

Specifies which networks to ignore during the operation. Networks with DHCP enabled are always included. Other networks need a static address to be specified using the -StaticAddress parameter or should be explicitly ignored with this -IgnoreNetwork parameter.

Default Value: **

Data Type: StringCollection

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

InputObject

Specifies the cluster to create the highly available service on.

Default Value: **

Data Type: psobject

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

true (ByValue)

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Name

Specifies the name of the cluster highly available service to create.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

1

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

ServiceName

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

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

StaticAddress

Specifies the static address(es) to use during the operation. Networks with DHCP enabled are always included. Other networks need a static address to be specified using the -StaticAddress parameter or should be explicitly ignored with this -IgnoreNetwork parameter.

Default Value: **

Data Type: StringCollection

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Storage

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

Default Value: **

Data Type: StringCollection

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Wait

Specifies the time in seconds to wait for the operation. If this parameter is not specified the operation waits for completion. If "-Wait 0" is specified the call is initiated and the cmdlet returns right away.

Default Value: **

Data Type: int

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Input Type

Microsoft.FailoverClusters.PowerShell.Cluster

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Examples

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

 
Add-ClusterGenericServiceRole -ServiceName Service1 
 
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1GenSvc             node1                              Online

Description

-----------

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

 

-------------------------- EXAMPLE 2 --------------------------

Command Prompt: C:\PS>

 
Add-ClusterGenericServiceRole -ServiceName Service1 -Storage "Cluster Disk 6" 
 
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1GenSvc             node1                              Online

Description

-----------

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

See Also

Reference

Get-ClusterGroup
Move-ClusterGroup
Remove-ClusterGroup
Start-ClusterGroup
Stop-ClusterGroup

Other Resources

Online version: