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-ClusterGenericApplicationRole

Add-ClusterGenericApplicationRole

microsoft.failoverclusters.powershell.dll

Synopsis

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

Syntax

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

Detailed Description

The Add-ClusterGenericApplicationRole cmdlet configures high availability for an application that was not 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.

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

-CommandLine <String>

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.

Aliases

None

Required?

true

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

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 application to create.

Aliases

None

Required?

false

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Parameters <String>

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

Aliases

None

Required?

false

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

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

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 NewApplication.exe as a generic clustered application. A default name will be used for client access and this application requires no storage.

PS C:\>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1GenApp             node2                              Online 

Example 2

This example configures NewApplication.exe as a generic clustered application using Cluster Disk 4, and assigns the name NewApplication.

PS C:\>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Storage "Cluster Disk 4" -Name NewApplication
Name                       OwnerNode                           State 
----                       ---------                           ----- 
NewApplication                 node2                          Online 

Example 3

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.

PS C:\>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Wait 0
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1GenApp             node2                             Pending 

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