Edit

Share via

Add-ClusterGenericApplicationRole

  • Reference
Module:
FailoverClusters

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

Syntax

Add-ClusterGenericApplicationRole
   -CommandLine <String>
   [-Parameters <String>]
   [-CheckpointKey <StringCollection>]
   [-Storage <StringCollection>]
   [-StaticAddress <StringCollection>]
   [-IgnoreNetwork <StringCollection>]
   [[-Name] <String>]
   [-Wait <Int32>]
   [-InputObject <PSObject>]
   [-Cluster <String>]
   [<CommonParameters>]

Description

The Add-ClusterGenericApplicationRole cmdlet configures high availability for an application that wasn't originally designed to run in a failover cluster.

If an application is run as a Generic Application, the cluster software will start the application, then periodically query the operating system to see whether the application 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 an application as a generic clustered application

Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe

This example configures NewApplication.exe as a generic clustered application. A default name will be used for client access and this application requires no storage.

Example 2: Configure an application with storage and name

$parameters = @{
    CommandLine = 'NewApplication.exe'
    Storage = 'Cluster Disk 4'
    Name = 'NewApplication'
}
Add-ClusterGenericApplicationRole @parameters

This example configures NewApplication.exe as a generic clustered application using Cluster Disk 4, and assigns the name NewApplication. This example uses splatting to pass parameter values from the $Parameters variable to the command. Learn more about Splatting.

Example 3: Configure application with no wait for resources

Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Wait 0

This example configures NewApplication.exe as a generic clustered application and assigns the name NewApplication. The cmdlet completes without waiting for all resources to come online.

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.

Type:StringCollection
Position:Named
Default value:None
Required: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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CommandLine

Specifies the Windows PowerShell command line to use for the highly available generic application. If the full path is specified, then the current directory is parsed out of the Windows PowerShell command line.

Type:String
Position:Named
Default value:None
Required:True
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.

Type:StringCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the highly available application to create.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Parameters

Specifies the parameters to use for the highly available generic application.

Type:String
Position:Named
Default value:None
Required:False
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.

Type:StringCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Storage

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

Type:StringCollection
Position:Named
Default value:None
Required:False
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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.FailoverClusters.PowerShell.Cluster

Outputs

Microsoft.FailoverClusters.PowerShell.ClusterGroup