Add-ClusterGenericApplicationRole
Add-ClusterGenericApplicationRole
Configures high availability for an application that was not originally designed to run in a failover cluster.
Syntax
Parameter Set: InputObject
Add-ClusterGenericApplicationRole [[-Name] <String> ] -CommandLine <String> [-CheckpointKey <StringCollection> ] [-Cluster <String> ] [-IgnoreNetwork <StringCollection> ] [-InputObject <PSObject> ] [-Parameters <String> ] [-StaticAddress <StringCollection> ] [-Storage <StringCollection> ] [-Wait <Int32> ] [ <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 |
none |
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 |
none |
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 |
none |
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 |
none |
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 |
none |
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 |
none |
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 |
none |
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 |
none |
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 |
none |
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 |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.FailoverClusters.PowerShell.Cluster
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.FailoverClusters.PowerShell.ClusterGroup
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
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
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