Add-Cluster Generic Script Role

Module:
failoverclusters
Configures an application controlled by a script that runs in Windows Script Host, within a failover cluster.

Syntax 

Add-ClusterGenericScriptRole
   -ScriptFilePath <String>
   [-Storage <StringCollection>]
   [-StaticAddress <StringCollection>]
   [-IgnoreNetwork <StringCollection>]
   [[-Name] <String>]
   [-Wait <Int32>]
   [-InputObject <PSObject>]
   [-Cluster <String>]
   [<CommonParameters>]

Description

The Add-ClusterGenericScriptRole cmdlet configures an application controlled by a script that runs in Windows Script Host, within a failover cluster.

The script provides the cluster software with information about the current state of the application. As needed, the cluster software will restart or fail over the script. Through the script, the application will 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 a script to run on a failover cluster 

PS C:\> Add-ClusterGenericScriptRole -ScriptFilePath "script1.vbs"
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1GenScript          node2                              Online

This example configures the script named script1.vbs to run within a failover cluster, using defaults for the name and IP address, and does not assign a disk.

Example 2: Configure a script on a failover cluster and assign a clustered script name 

PS C:\> Add-ClusterGenericScriptRole -ScriptFilePath "script1.vbs" -Storage "Cluster Disk 4" -Name "script1"
Name                       OwnerNode                           State 
----                       ---------                           ----- 
script1                    node2                              Online

This example configures the script named script1.vbs to run within a failover cluster and use Cluster Disk 4. The cmdlet assigns the clustered script the name script1.

Example 3: Configure a script to run on a fail over cluster without waiting for resources 

PS C:\> Add-ClusterGenericScriptRole -ScriptFilePath "script1.vbs" -Wait 0
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1GenScript          node2                             Pending

This example configures the script called script1.vbs to run within a failover cluster, using defaults for the name and IP address, and does not assign a disk. The cmdlet completes without waiting for all resources to come online.

Required Parameters

-ScriptFilePath

Specifies the path of the script file to use for the highly available script.

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

Optional Parameters

-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
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
Accept pipeline input: False
Accept wildcard characters: False
-InputObject

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

Type: PSObject
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Name

Specifies the name of the highly available script to create.

Type: String
Position: 0
Default value: None
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
Accept pipeline input: False
Accept wildcard characters: False
-Storage

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

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

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.

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

Inputs

Microsoft.FailoverClusters.PowerShell.Cluster

Outputs

Microsoft.FailoverClusters.PowerShell.ClusterGroup