Add-ClusterGenericScriptRole
Add-ClusterGenericScriptRole
Configures an application controlled by a script that runs in Windows Script Host, within a failover cluster.
Syntax
Parameter Set: InputObject
Add-ClusterGenericScriptRole [[-Name] <String> ] -ScriptFilePath <String> [-Cluster <String> ] [-IgnoreNetwork <StringCollection> ] [-InputObject <PSObject> ] [-StaticAddress <StringCollection> ] [-Storage <StringCollection> ] [-Wait <Int32> ] [ <CommonParameters>]
Detailed 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 (and through it, 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.
Parameters
-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 |
-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 script.
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 script to create.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ScriptFilePath<String>
Specifies the path of the script file to use for the highly available script.
Aliases |
none |
Required? |
true |
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 script.
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 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.
PS C:\> Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs
Example 2
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.
PS C:\> Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Storage "Cluster Disk 4" -Name script1
Example 3
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.
PS C:\> Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Wait 0