Add-ClusterGenericScriptRole

Article
07/03/2012

Add-ClusterGenericScriptRole

Configure an application controlled by a script that runs in Windows Script Host, within a failover cluster.

Syntax

Add-ClusterGenericScriptRole [-InputObject <psobject>] -ScriptFilePath <string> [[-Name] <string>] [-Cluster <string>] [-IgnoreNetwork <StringCollection>] [-StaticAddress <StringCollection>] [-Storage <StringCollection>] [-Wait <int>] [<CommonParameters>]

InputObject
ScriptFilePath
Name
Cluster
IgnoreNetwork
StaticAddress
Storage
Wait

Detailed Description

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).

Parameters

Cluster

Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.

Default Value: **

Data Type: string

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

IgnoreNetwork

Specifies which networks to ignore during the operation. Networks with DHCP enabled are always included. Other networks need a static address to be specified using the -StaticAddress parameter or should be explicitly ignored with this -IgnoreNetwork parameter.

Default Value: **

Data Type: StringCollection

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

InputObject

Specifies the cluster to create the highly available script on.

Default Value: **

Data Type: psobject

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	true (ByValue)	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

Name

Specifies the name of the cluster highly available script to create.

Default Value: **

Data Type: string

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	1	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

ScriptFilePath

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

Default Value: **

Data Type: string

Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

StaticAddress

Specifies the static address(es) to use during the operation. Networks with DHCP enabled are always included. Other networks need a static address to be specified using the -StaticAddress parameter or should be explicitly ignored with this -IgnoreNetwork parameter.

Default Value: **

Data Type: StringCollection

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

Storage

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

Default Value: **

Data Type: StringCollection

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

Wait

Specifies the time in seconds to wait for the operation. If this parameter is not specified the operation waits for completion. If "-Wait 0" is specified the call is initiated and the cmdlet returns right away.

Default Value: **

Data Type: int

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

Input Type

Microsoft.FailoverClusters.PowerShell.Cluster

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Examples

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

 
Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs 
 
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1GenScript          node2                              Online

Description

-----------

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

-------------------------- EXAMPLE 2 --------------------------

Command Prompt: C:\PS>

 
Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Storage "Cluster Disk 4" -Name script1 
 
Name                       OwnerNode                           State 
----                       ---------                           ----- 
script1                    node2                              Online

Description

-----------

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

-------------------------- EXAMPLE 3 --------------------------

Command Prompt: C:\PS>

 
Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Wait 0 
 
Name                       OwnerNode                           State 
----                       ---------                           ----- 
cluster1GenScript          node2                             Pending

Description

-----------

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

Add-ClusterGenericScriptRole