| description | external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
Microsoft.FailoverClusters.PowerShell.dll-Help.xml |
FailoverClusters |
11/22/2022 |
2.0.0 |
Add-ClusterGenericScriptRole |
Configures an application controlled by a script that runs in Windows Script Host, within a failover cluster.
Add-ClusterGenericScriptRole -ScriptFilePath <String> [-Storage <StringCollection>]
[-StaticAddress <StringCollection>] [-IgnoreNetwork <StringCollection>] [[-Name] <String>]
[-Wait <Int32>] [-InputObject <PSObject>] [-Cluster <String>] [<CommonParameters>]
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.
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.
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.
Add-ClusterGenericScriptRole -ScriptFilePath "script1.vbs" -Wait 0This 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.
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the cluster on which to create the highly available script.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the name of the highly available script to create.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the path of the script file to use for the highly available script.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the cluster disk resource to be added to the created highly available script.
Type: StringCollection
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.