Add-ClusterGenericScriptRole
Configures an application controlled by a script that runs in Windows Script Host, within a failover cluster.
Syntax
Default (Default)
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
Add-ClusterGenericScriptRole -ScriptFilePath "script1.vbs"
This example configures the script named script1.vbs to run within a failover cluster, using
defaults for the name and IP address, and doesn't assign a disk.
Example 2: Configure a script on a failover cluster and assign a clustered script name
Add-ClusterGenericScriptRole -ScriptFilePath "script1.vbs" -Storage "Cluster Disk 4" -Name "script1"
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
Add-ClusterGenericScriptRole -ScriptFilePath "script1.vbs" -Wait 0
This example configures the script called script1.vbs to run within a failover cluster, using
defaults for the name and IP address, and doesn't assign a disk. The cmdlet completes without
waiting for all resources to come online.
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | StringCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the cluster on which to create the highly available script.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the highly available script to create.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ScriptFilePath
Specifies the path of the script file to use for the highly available script.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | StringCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Storage
Specifies the cluster disk resource to be added to the created highly available script.
Parameter properties
| Type: | StringCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.