HelpCache/Microsoft.FailoverClusters.PowerShell.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!-- Updatable Help Version 4.0.1.0 --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterCheckpoint</command:name> <maml:description> <maml:para>Adds a cryptographic key checkpoint or registry checkpoint for a resource.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterCheckpoint</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterCheckpoint cmdlet adds a cryptographic key checkpoint or registry checkpoint for a resource.</maml:para> <maml:para>Checkpoints help provide failover support for applications that store configuration information locally instead of or in addition to storing information in the cluster configuration database. Applications might store information locally in two ways. One way is to store configuration information in the registry on the local server; another way is to use cryptographic keys on the local server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterCheckpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the resource for which a checkpoint should be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CryptoCheckpointKey</maml:name> <maml:description> <maml:para>Specifies the key of a cryptographic key checkpoint to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CryptoCheckpointName</maml:name> <maml:description> <maml:para>Specifies the name of a cryptographic key checkpoint to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CryptoCheckpointType</maml:name> <maml:description> <maml:para>Specifies the type of a cryptographic key checkpoint to add. Options depend on the cryptographic provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet or the cluster resource for which the checkpoint should be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RegistryCheckpoint</maml:name> <maml:description> <maml:para>Specifies the name of the registry checkpoint to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CryptoCheckpointKey</maml:name> <maml:description> <maml:para>Specifies the key of a cryptographic key checkpoint to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CryptoCheckpointName</maml:name> <maml:description> <maml:para>Specifies the name of a cryptographic key checkpoint to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CryptoCheckpointType</maml:name> <maml:description> <maml:para>Specifies the type of a cryptographic key checkpoint to add. Options depend on the cryptographic provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet or the cluster resource for which the checkpoint should be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RegistryCheckpoint</maml:name> <maml:description> <maml:para>Specifies the name of the registry checkpoint to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the resource for which a checkpoint should be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterCheckpoint -ResourceName "cluster name" -RegistryCheckpoint "software\clusname" Resource Name -------- ---- cluster name software\clusname </dev:code> <dev:remarks> <maml:para>This example adds a registry checkpoint called software\clusname for the resource named cluster name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name "Cluster Name" | Add-ClusterCheckpoint -CryptoCheckpointName "Microsoft Base Cryptographic Provider v1.0" -CryptoCheckpointType 1 -CryptoCheckpointKey "Crypto" Resource Name Type Key -------- ---- ---- --- Cluster Name Microsoft Base Cryptograph... 1 Crypto </dev:code> <dev:remarks> <maml:para>This example adds a cryptographic checkpoint for the resource named Cluster Name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321004</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterCheckpoint</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterCheckpoint</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterDisk</command:name> <maml:description> <maml:para>Makes a new disk available for use in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterDisk</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterDisk cmdlet makes a new disk available for use in a failover cluster. The disk (LUN) must be exposed to all nodes in the failover cluster, and should not be exposed to any other servers.</maml:para> <maml:para>When adding a disk, make sure that the configuration of the storage allows the operating system to recognize and mount the disk as needed. The disk must be a basic disk (not a dynamic disk) and should not be exposed to servers outside the cluster. The Get-ClusterAvailableDisk cmdlet gets information about disks that you can add to the cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterDisk</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the list of shared disks to add to the cluster. The list of disks is generated with the Get-ClusterAvailableDisk cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the list of shared disks to add to the cluster. The list of disks is generated with the Get-ClusterAvailableDisk cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterDiskInfo</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Management.Infrastructure.CimInstance</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This object is output from the Get-Disk and the Get-VirtualDisk cmdlets.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Disk</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterAvailableDisk | Add-ClusterDisk Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 7 OnlinePending Available Storage Physical Disk Cluster Disk 8 OnlinePending Available Storage Physical Disk </dev:code> <dev:remarks> <maml:para>This example identifies the disks that are ready to be added to the cluster, and then adds them to Available Storage cluster group.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterAvailableDisk | Where-Object –FilterScript { $_.ScsiAddress -Eq 50331651 } | Add-ClusterDisk Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 4 OnlinePending Available Storage Physical Disk </dev:code> <dev:remarks> <maml:para>This example examines disks that are ready to be added to the cluster, finds the disk with a specific SCSI address, and adds it to Available Storage cluster group.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Disk –Number 11 | Add-Clusterdisk Name State OwnerGroup ResourceType ---- ----- ---------- ------------ Cluster Disk 5 OnlinePending Available Storage Physical Disk </dev:code> <dev:remarks> <maml:para>This example clusters a physical disk; this cmdlet adds a physical disk to the Available Storage for the cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321005</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterAvailableDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Disk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VirtualDisk</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterFileServerRole</command:name> <maml:description> <maml:para>Creates a clustered file server (resource group that includes one or more disks, on which shared folders can be created for users).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterFileServerRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterFileServerRole cmdlet creates a clustered file server (resource group that includes one or more disks, on which shared folders can be created for users).</maml:para> <maml:para>When adding a clustered file server, specify a name for the file server, any IP address information that is not automatically supplied by your DHCP settings, and the storage volume or volumes that the clustered file server should use.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterFileServerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available file server to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available file server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available file server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available file server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available file server to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available file server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterFileServerRole -Storage "Cluster Disk 8" Name OwnerNode State ---- --------- ----- cluster1FS node1 Online </dev:code> <dev:remarks> <maml:para>This example creates a clustered file server using Cluster Disk 8, and assigns a default name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterFileServerRole -Storage "Cluster Disk 6" -Name cluster1FS12 Name OwnerNode State ---- --------- ----- cluster1FS12 node1 Online </dev:code> <dev:remarks> <maml:para>This example creates a clustered file server using Cluster Disk 6, and assigns the name cluster1FS12.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterFileServerRole -Storage "Cluster Disk 8" -Wait 0 Name OwnerNode State ---- --------- ----- cluster1FS node1 Pending </dev:code> <dev:remarks> <maml:para>This example creates a clustered file server using Cluster Disk 8, and assigns a default name. The cmdlet completes without waiting for all resources to come online.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321006</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterScaleOutFileServerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterGenericApplicationRole</command:name> <maml:description> <maml:para>Configures high availability for an application that was not originally designed to run in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterGenericApplicationRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterGenericApplicationRole cmdlet configures high availability for an application that was not originally designed to run in a failover cluster.</maml:para> <maml:para>If an application is run as a Generic Application, the cluster software will start the application, then periodically query the operating system to see whether the application appears to be running. If so, then it is presumed to be online and will not be restarted or failed over.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterGenericApplicationRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available application to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckpointKey</maml:name> <maml:description> <maml:para>Specifies a comma-separated list of registry checkpoint keys to add for this highly available generic application. All registry paths are relative to HKEY_LOCAL_MACHINE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies the parameters to use for the highly available generic application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CommandLine</maml:name> <maml:description> <maml:para>Specifies the Windows PowerShell® command line to use for the highly available generic application. If the full path is specified, then the current directory is parsed out of the Windows PowerShell command line.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckpointKey</maml:name> <maml:description> <maml:para>Specifies a comma-separated list of registry checkpoint keys to add for this highly available generic application. All registry paths are relative to HKEY_LOCAL_MACHINE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CommandLine</maml:name> <maml:description> <maml:para>Specifies the Windows PowerShell® command line to use for the highly available generic application. If the full path is specified, then the current directory is parsed out of the Windows PowerShell command line.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available application to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies the parameters to use for the highly available generic application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe Name OwnerNode State ---- --------- ----- cluster1GenApp node2 Online </dev:code> <dev:remarks> <maml:para>This example configures NewApplication.exe as a generic clustered application. A default name will be used for client access and this application requires no storage.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Storage "Cluster Disk 4" -Name NewApplication Name OwnerNode State ---- --------- ----- NewApplication node2 Online </dev:code> <dev:remarks> <maml:para>This example configures NewApplication.exe as a generic clustered application using Cluster Disk 4, and assigns the name NewApplication.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Wait 0 Name OwnerNode State ---- --------- ----- cluster1GenApp node2 Pending </dev:code> <dev:remarks> <maml:para>This example configures NewApplication.exe as a generic clustered application and assigns the name NewApplication. The cmdlet completes without waiting for all resources to come online.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321007</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterGenericScriptRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterGenericServiceRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterGenericScriptRole</command:name> <maml:description> <maml:para>Configures an application controlled by a script that runs in Windows Script Host, within a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterGenericScriptRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterGenericScriptRole cmdlet configures an application controlled by a script that runs in Windows Script Host, within a failover cluster.</maml:para> <maml:para>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).</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterGenericScriptRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available script to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available script.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available script.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ScriptFilePath</maml:name> <maml:description> <maml:para>Specifies the path of the script file to use for the highly available script.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available script.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available script to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ScriptFilePath</maml:name> <maml:description> <maml:para>Specifies the path of the script file to use for the highly available script.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available script.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs Name OwnerNode State ---- --------- ----- cluster1GenScript node2 Online </dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Storage "Cluster Disk 4" -Name script1 Name OwnerNode State ---- --------- ----- script1 node2 Online </dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Wait 0 Name OwnerNode State ---- --------- ----- cluster1GenScript node2 Pending </dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321008</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterGenericApplicationRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterGenericServiceRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterGenericServiceRole</command:name> <maml:description> <maml:para>Configures high availability for a service that was not originally designed to run in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterGenericServiceRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterGenericServiceRole cmdlet configures high availability for a service that was not originally designed to run in a failover cluster. The cluster software will start the service, then periodically query the Service Controller (a feature of the operating system) to determine whether the service appears to be running. If so, then it is presumed to be online, and will not be restarted or failed over.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterGenericServiceRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available service to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckpointKey</maml:name> <maml:description> <maml:para>Specifies a comma-separated list of registry checkpoint keys to add for this highly available generic application. All registry paths are relative to HKEY_LOCAL_MACHINE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>Specifies the time in seconds to wait for the cmdlet. If the <maml:system>Wait</maml:system> parameter is not specified, then the cmdlet waits for completion. If <maml:codeInline>-Wait 0</maml:codeInline> is specified, then the call is initiated and the cmdlet returns without waiting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the service name to use for the highly available service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckpointKey</maml:name> <maml:description> <maml:para>Specifies a comma-separated list of registry checkpoint keys to add for this highly available generic application. All registry paths are relative to HKEY_LOCAL_MACHINE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available service to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the service name to use for the highly available service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>Specifies the time in seconds to wait for the cmdlet. If the <maml:system>Wait</maml:system> parameter is not specified, then the cmdlet waits for completion. If <maml:codeInline>-Wait 0</maml:codeInline> is specified, then the call is initiated and the cmdlet returns without waiting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterGenericServiceRole -ServiceName Service1 Name OwnerNode State ---- --------- ----- cluster1GenSvc node1 Online </dev:code> <dev:remarks> <maml:para>This example configures Service1 as a generic clustered service, using defaults for the name and IP address, and does not assign a disk.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterGenericServiceRole -ServiceName Service1 -Storage "Cluster Disk 6" Name OwnerNode State ---- --------- ----- cluster1GenSvc node1 Online </dev:code> <dev:remarks> <maml:para>This example configures Service1 as a generic clustered service using Cluster Disk 6, and assigns defaults for the name and IP address.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321009</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterGenericApplicationRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterGenericScriptRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterGroup</command:name> <maml:description> <maml:para>Adds an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterGroup cmdlet adds an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group. A resource group, or a clustered role, is the unit of failover. During failover, all resources in the resource group move together.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the resource group to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>GroupType</maml:name> <maml:description> <maml:para>Specifies the type of group to add to the failover cluster configuration.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AvailableStorage</command:parameterValue> <command:parameterValue required="true" variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="true" variableLength="false">ClusterSharedVolume</command:parameterValue> <command:parameterValue required="true" variableLength="false">ClusterStoragePool</command:parameterValue> <command:parameterValue required="true" variableLength="false">DhcpServer</command:parameterValue> <command:parameterValue required="true" variableLength="false">Dtc</command:parameterValue> <command:parameterValue required="true" variableLength="false">FileServer</command:parameterValue> <command:parameterValue required="true" variableLength="false">GenericApplication</command:parameterValue> <command:parameterValue required="true" variableLength="false">GenericScript</command:parameterValue> <command:parameterValue required="true" variableLength="false">GenericService</command:parameterValue> <command:parameterValue required="true" variableLength="false">IScsiNameService</command:parameterValue> <command:parameterValue required="true" variableLength="false">IScsiTarget</command:parameterValue> <command:parameterValue required="true" variableLength="false">Msmq</command:parameterValue> <command:parameterValue required="true" variableLength="false">ScaleoutFileServer</command:parameterValue> <command:parameterValue required="true" variableLength="false">StandAloneDfs</command:parameterValue> <command:parameterValue required="true" variableLength="false">TaskScheduler</command:parameterValue> <command:parameterValue required="true" variableLength="false">Temporary</command:parameterValue> <command:parameterValue required="true" variableLength="false">TsSessionBroker</command:parameterValue> <command:parameterValue required="true" variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> <command:parameterValue required="true" variableLength="false">VMReplicaBroker</command:parameterValue> <command:parameterValue required="true" variableLength="false">Wins</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the resource group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>GroupType</maml:name> <maml:description> <maml:para>Specifies the type of group to add to the failover cluster configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GroupType</command:parameterValue> <dev:type> <maml:name>GroupType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the resource group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the resource group to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterGroup –Name Group1 Name OwnerNode State ---- --------- ----- Group1 node1 Online </dev:code> <dev:remarks> <maml:para>This example adds an empty resource group called Group1 to the failover cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321010</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusteriSCSITargetServerRole</command:name> <maml:description> <maml:para>Creates a highly available iSCSI Target server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusteriSCSITargetServerRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusteriSCSITargetServerRole cmdlet creates a highly available iSCSI Target server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusteriSCSITargetServerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available iSCSI Target server to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available iSCSI Target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available iSCSI Target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available iSCSI Target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available iSCSI Target server to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available iSCSI Target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusteriSCSITargetServerRole -Storage "Cluster Disk 5" Name OwnerNode State ---- --------- ----- CLiSCSITarget node1 Online </dev:code> <dev:remarks> <maml:para>This example creates a clustered iSCSI Target server using Cluster Disk 5, and assigns a default name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusteriSCSITargetServerRole -Storage "Cluster Disk 5" -Name MyiSCSITarget Name OwnerNode State ---- --------- ----- MyiSCSITarget node1 Online </dev:code> <dev:remarks> <maml:para>This example creates a clustered iSCSI Target server using Cluster Disk 5, and assigns the name MyiSCSITarget.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusteriSCSITargetServerRole -Storage "Cluster Disk 5" -Wait 0 Name OwnerNode State ---- --------- ----- CLiSCSITarget node1 Pending </dev:code> <dev:remarks> <maml:para>This example creates a clustered iSCSI Target server using Cluster Disk 5, and assigns a default name. The cmdlet completes without waiting for all resources to come online.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321011</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-IscsiServerTarget</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterNode</command:name> <maml:description> <maml:para>Adds a node (server) to a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterNode cmdlet adds a node, or server, to a failover cluster. Before adding the new node, you should run validation tests on the existing nodes together with the proposed new node.</maml:para> <maml:para>Before adding the new node, you should run validation tests on the existing nodes together with the proposed new node. By running the validation tests, you can confirm that the server to be added is connected correctly to the networks and storage and that it contains the same software updates.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster to which to add the new cluster node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NoStorage</maml:name> <maml:description> <maml:para>Ensures that shared storage, on the node being joined to the cluster, will not be added to the cluster during the join operation. Shared storage can be added by piping the ClusterDiskInfo object from the Get-ClusterAvailableDisk cmdlet into the Add-ClusterDisk cmdlet.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster to which to add the new cluster node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NoStorage</maml:name> <maml:description> <maml:para>Ensures that shared storage, on the node being joined to the cluster, will not be added to the cluster during the join operation. Shared storage can be added by piping the ClusterDiskInfo object from the Get-ClusterAvailableDisk cmdlet into the Add-ClusterDisk cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterNode –Name node4 Name State ---- ----- node4 Up </dev:code> <dev:remarks> <maml:para>This example adds node named node4 to the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Cluster –Name cluster1 | Add-ClusterNode –Name node3 Name State ---- ----- node3 Up </dev:code> <dev:remarks> <maml:para>This example adds the node named node3 to cluster called cluster1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321012</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterAvailableDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterPrintServerRole</command:name> <maml:description> <maml:para>Creates a clustered print server, a resource group that includes a printer and a disk for storing print job information and printer drivers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterPrintServerRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterPrintServerRole cmdlet creates a clustered print server (a resource group that includes a printer and a disk for storing print job information and printer drivers).</maml:para> <maml:para>When adding a clustered print server, specify a name for the print server, any IP address information that is not automatically supplied by your DHCP settings, and the storage volume or volumes that the clustered print server should use for print job information and printer drivers.</maml:para> <maml:para>Note: This cmdlet has been deprecated and is only supported on Windows Server® 2008 R2 and lower.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterPrintServerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available print server to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available print server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available print server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available print server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available print server to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available print server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterPrintServerRole -Storage "Cluster Disk 5" Name OwnerNode State ---- --------- ----- cluster1PS node1 Online </dev:code> <dev:remarks> <maml:para>This example creates a clustered print server using Cluster Disk 5, and assigns a default name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterPrintServerRole -Storage "Cluster Disk 5" -Name MyPrintServer Name OwnerNode State ---- --------- ----- MyPrintServer node1 Online </dev:code> <dev:remarks> <maml:para>This example creates a clustered print server using Cluster Disk 5, and assigns the name MyPrintServer.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321013</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterResource</command:name> <maml:description> <maml:para>Adds a resource to a clustered role, or resource group, in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterResource cmdlet adds a resource to a clustered role, or resource group, in a failover cluster. Before adding the resource, obtain the resource type and the name of the group to which to add the resource.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterResource</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the clustered role where the new resource is added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="restype, type"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource type for the new cluster resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered role where the new resource is added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SeparateMonitor</maml:name> <maml:description> <maml:para>Specifies that the new resource should run in a separate resource monitor.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the clustered role where the new resource is added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered role where the new resource is added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="restype, type"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource type for the new cluster resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SeparateMonitor</maml:name> <maml:description> <maml:para>Specifies that the new resource should run in a separate resource monitor.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterResource -Name resource1 -ResourceType "IP Address" -Group ClusterSrv1 Name State Group ResourceType ---- ----- ----- ------------ resource1 Offline ClusterSrv1 IP Address </dev:code> <dev:remarks> <maml:para>This example creates a new IP Address resource called resource1 on the local cluster. The cmdlet configures the resource as part of the clustered role, or resource group, called ClusterSrv1.</maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321014</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterResourceDependency</command:name> <maml:description> <maml:para>Adds a resource to the list of resources on which a particular resource depends, using AND as the connector, within a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterResourceDependency</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterResourceDependency cmdlet adds a resource to the list of resources on which a particular resource depends, using AND as the connector, within a failover cluster. Existing dependencies will remain in the list.</maml:para> <maml:para>A dependent resource is brought online after the resources on which it depends. A dependent resource is taken offline before the resources on which it depends.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterResourceDependency</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which to add a dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specifies the cluster resource on which to add a dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource for which to add the dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource for which to add the dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specifies the cluster resource on which to add a dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which to add a dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterResourceDependency –Cluster "FileServer-(cluster1FS12)(Cluster Disk 2)" –Resource "Cluster Disk 4" Name State Group ResourceType ---- ----- ----- ------------ FileServer-(clus... Online cluster1FS12 File Server </dev:code> <dev:remarks> <maml:para>This example adds the resource named Cluster Disk 4 to the list of resources on which the resource called FileServer-(cluster1FS12)(Cluster Disk 2) depends, using AND as the connector.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321015</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResourceDependencyReport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterResourceType</command:name> <maml:description> <maml:para>Adds a resource type to a failover cluster, and specifies information such as the dynamic-link library (DLL) to use with that resource type.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterResourceType</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterResourceType cmdlet adds a resource type to a failover cluster, and specifies information such as the dynamic-link library (DLL) to use with that resource type.</maml:para> <maml:para>The failover cluster software provides Resource DLL files for the most common types of resources. Using the application programming interface (API) provided in the Microsoft Platform Software Development Kit (SDK), other vendors can add support for other resource types.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterResourceType</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource type to register.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Dll</maml:name> <maml:description> <maml:para>Specifies the DLL file path for the resource type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name for the resource type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to register the new resource type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name for the resource type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Dll</maml:name> <maml:description> <maml:para>Specifies the DLL file path for the resource type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to register the new resource type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource type to register.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResourceType</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterResourceType -Name ResType3 –InputObject C:\res3.dll Name DisplayName ---- ----------- ResType3 ResType3 </dev:code> <dev:remarks> <maml:para>This example creates ResType3 on the local cluster using res3.dll located on the provided resource DLL file path C:\.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterResourceType –Name ResType4 -InputObject C:\res4.dll -DisplayName "Resource Type 4" Name DisplayName ---- ----------- ResType4 Resource Type 4 </dev:code> <dev:remarks> <maml:para>This example creates ResType4 on the local cluster using res4.dll located on the provided resource DLL file path C:\. The display name of the resource type is Resource Type 4.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321016</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResourceType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResourceType</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterScaleOutFileServerRole</command:name> <maml:description> <maml:para>Creates a clustered file server for scale-out application data.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterScaleOutFileServerRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterScaleOutFileServerRole cmdlet creates a clustered file server for scale-out application data. A file server for scale-out application data provides storage for applications or virtual machines that leave files open for extended periods of time. Client connections are distributed across nodes for better throughput. This type of file server supports the Server Message Block (SMB) protocol. It does not support the Network File System (NFS) protocol, or certain role services such as File Server Resource Manager (FSRM) or Distributed File System (DFS) Replication.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterScaleOutFileServerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available scale-out file server being created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available scale-out file server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available scale-out file server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available scale-out file server being created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterScaleOutFileServerRole Name OwnerNode State ---- --------- ----- clusterSOFS CLUSTER-N2 Online </dev:code> <dev:remarks> <maml:para>This example creates a highly available Scale-out file server role.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterScaleOutFileServerRole -Wait 0 Name OwnerNode State ---- --------- ----- clusterSOFS CLUSTER-N2 Pending </dev:code> <dev:remarks> <maml:para>This example creates a highly available scale out file server role. The cmdlet completes without waiting for all resources to come online.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321017</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterFileServerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterServerRole</command:name> <maml:description> <maml:para>Creates a highly available basic server that contains only a client access point and storage.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterServerRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterServerRole cmdlet creates a highly available basic server that contains only a client access point and storage. After adding the basic server, other resources can be added to create a functional clustered role.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterServerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available server to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available role or application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available role or application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available server to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the created highly available server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterServerRole Name OwnerNode State ---- --------- ----- cluster1Other node2 Online </dev:code> <dev:remarks> <maml:para>This example establishes a default name for a clustered server. It does not specify any storage. Storage and other resources can be added later.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterServerRole -Storage "Cluster Disk 3" -Name MainSrv1 Name OwnerNode State ---- --------- ----- MainSrv1 node2 Online </dev:code> <dev:remarks> <maml:para>This example creates a clustered service or application using Cluster Disk 3, and assigns the name MainSrv1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterServerRole -Storage "Cluster Disk 4","Cluster Disk 5" -Name MainSrv2 Name OwnerNode State ---- --------- ----- MainSrv2 node2 Online </dev:code> <dev:remarks> <maml:para>This example creates a clustered service or application using Cluster Disk 4 and Cluster Disk 5, and assigns the name MainSrv2.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321018</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterSharedVolume</command:name> <maml:description> <maml:para>Makes a volume available in Cluster Shared Volumes in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterSharedVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterSharedVolume cmdlet makes a volume available in the Cluster Shared Volumes in a failover cluster. The Cluster Shared Volume must be chosen from the disks in Available Storage (that is, disks that have been added to the cluster but not assigned to a specific use in the cluster).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterSharedVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster disk resource to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the Cluster Shared Volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster disk resource to be added to the Cluster Shared Volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster disk resource to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterSharedVolume –Name "Cluster Disk 4" Name State Node ---- ----- ---- Cluster Disk 4 Online node2 </dev:code> <dev:remarks> <maml:para>This example adds Cluster Disk 4 to the Cluster Shared Volumes on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321019</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterVirtualMachineRole</command:name> <maml:description> <maml:para>Creates a clustered virtual machine, that is, a virtual machine that can be failed over if necessary to a different server in the failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterVirtualMachineRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterVirtualMachineRole cmdlet creates a clustered virtual machine, that is, a virtual machine that can be failed over if necessary to a different server in the failover cluster.</maml:para> <maml:para>By creating clustered virtual machines, you can consolidate multiple servers on one physical server without causing that server to become a single point of failure. Instead, if that server, or cluster node, fails or requires scheduled maintenance, then another node begins to run the virtual machines instead through a process known as failover. The virtual hard disk (VHD) file for the clustered virtual machine must be on the clustered disk used by that virtual machine.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterVirtualMachineRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VMName</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to make highly available. Use either the VirtualMachine parameter or the VMName parameter to specify the name of the virtual machine. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available virtual machine to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="vm"> <maml:name>VirtualMachine</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to make highly available. Use either the VirtualMachine parameter or the VMName parameter to specify the name of the virtual machine. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>VMId</maml:name> <maml:description> <maml:para>Specifies the virtual machine identifier (ID).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to create the highly available virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the highly available virtual machine to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>VMId</maml:name> <maml:description> <maml:para>Specifies the virtual machine identifier (ID).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VMName</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to make highly available. Use either the VirtualMachine parameter or the VMName parameter to specify the name of the virtual machine. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="vm"> <maml:name>VirtualMachine</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to make highly available. Use either the VirtualMachine parameter or the VMName parameter to specify the name of the virtual machine. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterVirtualMachineRole -VirtualMachine VM1 Name OwnerNode State ---- --------- ----- Virtual Machine node1 Offline </dev:code> <dev:remarks> <maml:para>This example configures VM1 as a clustered virtual machine, and assigns a default name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterVirtualMachineRole -VirtualMachine VM1 -Name "MainServer1" Name OwnerNode State ---- --------- ----- MainServer1 node1 Offline </dev:code> <dev:remarks> <maml:para>This example configures VM1 as a clustered virtual machine, and assigns the name MainServer1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-VM –Name *print* | Add-ClusterVirtualMachineRole Report file location: C:\Windows\cluster\Reports\Highly Available Virtual Machine 0ce88dce-eb6b-4c17-a512-d13bdbe5fcba on2011.11.28 At 15.37.33.mht Name OwnerNode State ---- --------- ----- print-VM1 node1 Online </dev:code> <dev:remarks> <maml:para>This example queries for virtual machines matching the wildcard characters *print* and configures them as clustered virtual machines.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321020</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterVirtualMachineRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-ClusterVirtualMachineConfiguration</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ClusterVMMonitoredItem</command:name> <maml:description> <maml:para>Configures monitoring for a service or an Event Tracing for Windows (ETW) event so that it is monitored on a virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>ClusterVMMonitoredItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-ClusterVMMonitoredItem cmdlet configures monitoring for a service or an Event Tracing for Windows (ETW) event so that it is monitored on a virtual machine. If the service fails or the event occurs, then the system responds by taking an action based on the failover configuration for the virtual machine resource. For example, the configuration might specify that the virtual machine be restarted.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ClusterVMMonitoredItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>VirtualMachine</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine on which to perform monitoring. When this parameter is specified, the cmdlet must be run on one of the host cluster nodes, or else the Cluster parameter must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the event identifier (ID) of the event to be monitored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventLog</maml:name> <maml:description> <maml:para>Specifies the event log of the event to be monitored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventSource</maml:name> <maml:description> <maml:para>Specifies the event source of the event to be monitored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet, the clustered virtual machine on which to configure monitoring, and the cluster virtual machine monitored item object to monitor.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OverrideServiceRecoveryActions</maml:name> <maml:description> <maml:para>Specifies that the cluster service will fix, by overriding, the service recovery actions in the event that it is not properly configured for monitoring. To be configured for monitoring the following conditions need to be met: -- None of the service recovery actions are set to Restart the computer. ---- AND -- At least one of the service recovery actions are set to Take no action. </maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies the name of a service to be monitored. This must be the short name, not the long name, of the service. For example, specify clussvc instead of Failover Cluster service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the event identifier (ID) of the event to be monitored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventLog</maml:name> <maml:description> <maml:para>Specifies the event log of the event to be monitored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventSource</maml:name> <maml:description> <maml:para>Specifies the event source of the event to be monitored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet, the clustered virtual machine on which to configure monitoring, and the cluster virtual machine monitored item object to monitor.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OverrideServiceRecoveryActions</maml:name> <maml:description> <maml:para>Specifies that the cluster service will fix, by overriding, the service recovery actions in the event that it is not properly configured for monitoring. To be configured for monitoring the following conditions need to be met: -- None of the service recovery actions are set to Restart the computer. ---- AND -- At least one of the service recovery actions are set to Take no action. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies the name of a service to be monitored. This must be the short name, not the long name, of the service. For example, specify clussvc instead of Failover Cluster service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>VirtualMachine</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine on which to perform monitoring. When this parameter is specified, the cmdlet must be run on one of the host cluster nodes, or else the Cluster parameter must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterVMMonitoredItem</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterVMMonitoredItem –VirtualMachine test-VM11 -EventLog "Microsoft-Windows-FailoverClustering-Manager/Admin" -EventSource "Microsoft-Windows-FailoverClustering-Manager" -EventId 4708 Name ---- Microsoft-Windows-FailoverClustering-Manager+Admin,Microsoft-Windows-FailoverClustering-Manager,4708 </dev:code> <dev:remarks> <maml:para>This example adds monitoring for the ETW event ID 4708.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-ClusterVMMonitoredItem –VirtualMachine test-VM11 -Service spooler Name ---- Spooler </dev:code> <dev:remarks> <maml:para>This example configures monitoring for the print spooler service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/p/?LinkId=321021</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterVMMonitoredItem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterVMMonitoredItem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-ClusterVMMonitoredState</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Block-ClusterAccess</command:name> <maml:description> <maml:para>Prevents the specified user or users from accessing a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Block</command:verb> <command:noun>ClusterAccess</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Block-ClusterAccess cmdlet prevents the specified user or users from accessing a failover cluster. If you do not want to completely block access and instead want to limit a user to using Windows PowerShell® to view cluster settings (not change settings), then use the Grant-ClusterAccess cmdlet with the Readonly parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Block-ClusterAccess</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user for whom to block cluster access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to block access for the given user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to block access for the given user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user for whom to block cluster access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Block-ClusterAccess –User contoso\johnj99 </dev:code> <dev:remarks> <maml:para>This example prevents the user named johnj99 on the contoso domain from gaining access to the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321022</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Grant-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-ClusterDiskReservation</command:name> <maml:description> <maml:para>Clears the persistent reservation on a disk in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>ClusterDiskReservation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-ClusterDiskReservation cmdlet clears the persistent reservation on a disk in a failover cluster. This cmdlet prompts for confirmation unless you specify the Force parameter.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-ClusterDiskReservation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node on which to clear the disk reservation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Disk</maml:name> <maml:description> <maml:para>Specifies the disk number on which to clear the persistent reservations. This is the disk number as it appears in Disk Management on the node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UInt32[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Disk</maml:name> <maml:description> <maml:para>Specifies the disk number on which to clear the persistent reservations. This is the disk number as it appears in Disk Management on the node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node on which to clear the disk reservation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Clear-ClusterDiskReservation -Disk 5 </dev:code> <dev:remarks> <maml:para>This example clears the persistent reservation on Disk 5 on the local node after asking for user confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\PS>Clear-ClusterDiskReservation -Disk 6 -Node node2 -Force </dev:code> <dev:remarks> <maml:para>This example clears the persistent reservation on Disk 6 on the node named node2 without asking for user confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321023</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-ClusterNode</command:name> <maml:description> <maml:para>Clears the cluster configuration from a node that was evicted from a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>ClusterNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-ClusterNode cmdlet clears the cluster configuration from a node that was evicted from a failover cluster. This cmdlet helps ensure that the failover cluster configuration has been completely removed from a node that was evicted.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-ClusterNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node for which to clear the cluster configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node from which to clear cluster the configuration information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node from which to clear cluster the configuration information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node for which to clear the cluster configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Clear-ClusterNode –Name node4 -Force </dev:code> <dev:remarks> <maml:para>This example removes cluster configuration information from the node named node4 without asking for user confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Clear-ClusterNode </dev:code> <dev:remarks> <maml:para>This example removes cluster configuration information from the local node after prompting for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321024</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Cluster</command:name> <maml:description> <maml:para>Gets information about one or more failover clusters in a given domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>Cluster</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-Cluster cmdlet gets information about one or more failover clusters in a given domain.</maml:para> <maml:para>This cmdlet can obtain a variety of configuration and state information about a failover cluster, including the following items: -- State information about whether a backup is in progress. -- State information about whether the cluster is in a forced quorum state. -- Cross-network settings that are especially relevant for multi-site clusters.</maml:para> <maml:para>To set a common property for the cluster, use this cmdlet to get the cluster object and then set the appropriate property on that cluster object directly.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Cluster</maml:name> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specifies the name of the domain in which to enumerate clusters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specifies the name of the domain in which to enumerate clusters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Cluster | Format-List –Property * Domain : contoso.com Name : cluster1 AddEvictDelay : 60 BackupInProgress : 0 ClusSvcHangTimeout : 60 ClusSvcRegroupOpeningTimeout : 5 ClusSvcRegroupPruningTimeout : 5 ClusSvcRegroupStageTimeout : 5 ClusSvcRegroupTickInMilliseconds : 300 ClusterGroupWaitDelay : 120 MinimumNeverPreemptPriority : 3000 MinimumPreemptorPriority : 1 ClusterEnforcedAntiAffinity : 0 ClusterLogLevel : 3 ClusterLogSize : 300 CrossSubnetDelay : 1000 CrossSubnetThreshold : 5 DefaultNetworkRole : 2 Description : FixQuorum : 0 HangRecoveryAction : 3 IgnorePersistentStateOnStartup : 0 LogResourceControls : 0 PlumbAllCrossSubnetRoutes : 0 PreventQuorum : 0 QuorumArbitrationTimeMax : 20 RequestReplyTimeout : 60 RootMemoryReserved : 4294967295 RouteHistoryLength : 0 SameSubnetDelay : 1000 SameSubnetThreshold : 5 SecurityLevel : 1 SharedVolumeCompatibleFilters : {} SharedVolumeIncompatibleFilters : {} SharedVolumesRoot : C:\ClusterStorage SharedVolumeSecurityDescriptor : {1, 0, 4, 128...} ShutdownTimeoutInMinutes : 20 UseNetftForSharedVolumes : 1 UseClientAccessNetworksForSharedVolumes : 0 SharedVolumeBlockCacheSizeInMB : 0 WitnessDatabaseWriteTimeout : 300 WitnessRestartInterval : 15 EnableSharedVolumes : Enabled DynamicQuorum : 1 Id : af5881ef-0ff7-4b5c-bfed-098decbbf762 </dev:code> <dev:remarks> <maml:para>This example displays state and property information for the local cluster in the form of a list.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Cluster –Name cluster1 Name ---- cluster1 </dev:code> <dev:remarks> <maml:para>This example gets information about a cluster named cluster1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Cluster -Domain contoso.com Name ---- cluster1 cluster2 cluster3 </dev:code> <dev:remarks> <maml:para>This example gets information about each of the clusters in the contoso.com domain.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-Cluster | ForEach-Object –Process {$_.CrossSubnetDelay = 1500} </dev:code> <dev:remarks> <maml:para>This example sets the common property called CrossSubnetDelay for the local cluster to 1500.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 5</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>(Get-Cluster).DynamicQuorum = 1 </dev:code> <dev:remarks> <maml:para>This example enables the Dynamic Quorum feature for the cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/p/?LinkId=321025</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ForEach-Object</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Format-List</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterAccess</command:name> <maml:description> <maml:para>Gets information about permissions that control access to a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterAccess</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterAccess cmdlet gets information about permissions that control access to a failover cluster.</maml:para> <maml:para>A cluster can allow full access or read-only access. Read-only access limits the user to Windows PowerShell® cmdlets that provide information about the cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterAccess</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user for which to get cluster access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate cluster access details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate cluster access details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user for which to get cluster access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterAccessRule</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterAccess IdentityReference AccessControlType ClusterRights ----------------- ----------------- ------------- CONTOSO\user1 Deny Full NT AUTHORITY\SYSTEM Allow Full NT AUTHORITY\NETWORK SE... Allow Full BUILTIN\Administrators Allow Full CONTOSO\user2 Allow Read NT SERVICE\MSDTC Allow Full </dev:code> <dev:remarks> <maml:para>This example lists the level of permissions that have been assigned to users of this cluster, including users who are blocked from access.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321026</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Block-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Grant-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterAvailableDisk</command:name> <maml:description> <maml:para>Gets information about the disks that can support Failover Clustering and are visible to all nodes, but are not yet part of the set of clustered disks.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterAvailableDisk</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterAvailableDisk cmdlet gets information about the disks that can support Failover Clustering and are visible to all nodes, but are not yet part of the set of clustered disks.</maml:para> <maml:para>If a disk is unexpectedly missing from the list of disks that are available for use in the cluster, then make sure that the configuration of the storage allows the operating system on all clustered servers to recognize and mount the disk as needed. The disk must be a basic disk, not a dynamic disk, and should not be exposed to any other servers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterAvailableDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>Disk</maml:name> <maml:description> <maml:para>Specifies the disks on which to enumerate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimInstance</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate available shared disks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>Disk</maml:name> <maml:description> <maml:para>Specifies the disks on which to enumerate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimInstance</command:parameterValue> <dev:type> <maml:name>CimInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate available shared disks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterDiskInfo</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterAvailableDisk Cluster : cluster1 Id : 2654136007 Name : Cluster Disk 4 Number : 7 ScsiAddress : 50331651 Size : 2097152000 Partitions : {\\?\GLOBALROOT\Device\Harddisk7\Partition1\} Cluster : cluster1 Id : 2654136015 Name : Cluster Disk 5 Number : 9 ScsiAddress : 67108867 Size : 2097152000 Partitions : {\\?\GLOBALROOT\Device\Harddisk9\Partition1\} </dev:code> <dev:remarks> <maml:para>This example lists the disks that are ready to be added to the cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterAvailableDisk | Add-ClusterDisk Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 4 OnlinePending Available Storage Physical Disk Cluster Disk 5 OnlinePending Available Storage Physical Disk </dev:code> <dev:remarks> <maml:para>This example adds all disks that are ready to be added to the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321027</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterDisk</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterCheckpoint</command:name> <maml:description> <maml:para>Retrieves a cryptographic key checkpoint or registry checkpoint for a resource.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterCheckpoint</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterCheckpoint cmdlet retrieves a cryptographic key checkpoint or registry checkpoint for a resource.</maml:para> <maml:para>Checkpoints help provide failover support for applications that store configuration information locally instead of or in addition to storing information in the cluster configuration database. Applications might store information locally in two ways. One way is to store configuration information in the registry on the local server; another way is to use cryptographic keys on the local server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterCheckpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the resource for which to retrieve the checkpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckpointName</maml:name> <maml:description> <maml:para>Specifies the name of checkpoints for which to search. Use of wildcard expressions is accepted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CryptoCheckpoint</maml:name> <maml:description> <maml:para>Specifies that cryptographic checkpoints will be retrieved.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet or the cluster resource for which to retrieve the checkpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RegistryCheckpoint</maml:name> <maml:description> <maml:para>Specifies that registry checkpoints will be retrieved.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckpointName</maml:name> <maml:description> <maml:para>Specifies the name of checkpoints for which to search. Use of wildcard expressions is accepted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CryptoCheckpoint</maml:name> <maml:description> <maml:para>Specifies that cryptographic checkpoints will be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet or the cluster resource for which to retrieve the checkpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RegistryCheckpoint</maml:name> <maml:description> <maml:para>Specifies that registry checkpoints will be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the resource for which to retrieve the checkpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterCheckpoint Resource Name Type Key -------- ---- ---- --- Cluster Name Microsoft Enhanced Cryptog... b5a571f2-c28b-48fa-b82f-a8... Cluster Name software\clusname </dev:code> <dev:remarks> <maml:para>This example retrieves all cluster checkpoints.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –ResourceName "Cluster Name" | Get-ClusterCheckpoint -CryptoCheckpoint Resource Name Type Key -------- ---- ---- --- Cluster Name Microsoft Enhanced Cryptog... b5a571f2-c28b-48fa-b82f-a8... </dev:code> <dev:remarks> <maml:para>This example retrieves the cryptographic checkpoints for the resource named Cluster Name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321028</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterCheckpoint</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterCheckpoint</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterGroup</command:name> <maml:description> <maml:para>Gets information about one or more clustered roles (resource groups) in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterGroup cmdlet gets information about one or more clustered roles (resource groups) in a failover cluster.</maml:para> <maml:para>A resource group is the unit of failover. During failover, all resources in the resource group move together.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered role to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster or cluster node on which to enumerate the clustered roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>VMId</maml:name> <maml:description> <maml:para>Specifies the virtual machine identifier (ID).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster or cluster node on which to enumerate the clustered roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered role to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>VMId</maml:name> <maml:description> <maml:para>Specifies the virtual machine identifier (ID).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterGroup Name OwnerNode State ---- --------- ----- Available Storage node1 Online Cluster Group node2 Online cluster1FS node1 Online cluster1FS-Other node1 Online </dev:code> <dev:remarks> <maml:para>This example lists the state and owner node of each clustered role, or resource group, in the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterGroup –Name "Cluster Group" | Get-ClusterResource Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 1 Online Cluster Group Physical Disk Cluster IP Address Online Cluster Group IP Address Cluster IP Addre... Online Cluster Group IPv6 Address Cluster Name Online Cluster Group Network Name </dev:code> <dev:remarks> <maml:para>This example lists the resources in Cluster Group on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterNode –Name node1 | Get-ClusterGroup Name OwnerNode State ---- --------- ----- Cluster Group node1 Online </dev:code> <dev:remarks> <maml:para>This example lists the clustered services and applications, or resource groups, that are currently owned by node1 in the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterGroup –Name FileServer1 | Format-List –Process * Cluster : Cluster1 IsCoreGroup : False OwnerNode : node1 State : Online Name : FileServer1 Description : PersistentState : 0 FailoverThreshold : 4294967295 FailoverPeriod : 6 AutoFailbackType : 0 FailbackWindowStart : 4294967295 FailbackWindowEnd : 4294967295 AntiAffinityClassNames : {} Id : 189ec8ad-1831-4f57-9bb0-3ffb9cbb9227 </dev:code> <dev:remarks> <maml:para>This example displays the properties of a clustered file server, or resource group, called FileServer1, in the form of a list.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321029</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Format-List</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterLog</command:name> <maml:description> <maml:para>Creates a log file for all nodes, or a specific a node, in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterLog cmdlet creates a log file for all nodes, or a specific a node, in a failover cluster.</maml:para> <maml:para>When creating a log file for the cluster, you can specify the timespan that you want logged information for in addition to providing a destination for the created logs.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node for which to generate the cluster log.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the location to which to copy one or more cluster logs. To copy to the current folder, use . for this parameter input.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster from which to generate cluster logs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="span"> <maml:name>TimeSpan</maml:name> <maml:description> <maml:para>Specifies the time span for which to generate the cluster log.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UseLocalTime</maml:name> <maml:description> <maml:para>Specifies that the time stamp for each cluster log entry uses local time. By default, the timestamp uses Greenwich Mean Time (GMT).</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the location to which to copy one or more cluster logs. To copy to the current folder, use . for this parameter input.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster from which to generate cluster logs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node for which to generate the cluster log.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="span"> <maml:name>TimeSpan</maml:name> <maml:description> <maml:para>Specifies the time span for which to generate the cluster log.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UseLocalTime</maml:name> <maml:description> <maml:para>Specifies that the time stamp for each cluster log entry uses local time. By default, the timestamp uses Greenwich Mean Time (GMT).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterLog Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 9/4/2008 3:53 PM 2211301 Cluster.log -a--- 9/4/2008 3:53 PM 1261025 Cluster.log </dev:code> <dev:remarks> <maml:para>This example creates a log file for the local cluster in the cluster reports folder on each node of the cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterLog -Destination . Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 9/4/2008 3:55 PM 2211301 node1_cluster.log -a--- 9/4/2008 3:55 PM 1261025 node2_cluster.log </dev:code> <dev:remarks> <maml:para>This example creates a log file for each node of the local cluster, and copies all logs to the local folder.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterLog -TimeSpan 5 Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 9/4/2008 3:58 PM 128299 Cluster.log -a--- 9/4/2008 4:01 PM 104181 Cluster.log </dev:code> <dev:remarks> <maml:para>This example creates a log file for the local cluster in the cluster reports folder on each node of the cluster. The log covers the last 5 minutes.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321030</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ClusterLog</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterNetwork</command:name> <maml:description> <maml:para>Gets information about one or more networks in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterNetwork</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterNetwork cmdlet gets information about one or more networks in a failover cluster. A failover cluster requires network connectivity among nodes and between clients and nodes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterNetwork</maml:name> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster network to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate the cluster networks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate the cluster networks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster network to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNetwork</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterNetwork Name State ---- ----- Cluster Network 1 Up Cluster Network 2 Up Cluster Network 3 Up </dev:code> <dev:remarks> <maml:para>This example gets information about the networks used by the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>(Get-ClusterNetwork –Name "Cluster Network 1").Name = "Cluster Network 3" </dev:code> <dev:remarks> <maml:para>This example renames Cluster Network 1 to Cluster Network 3.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321031</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterNetworkInterface</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterNetworkInterface</command:name> <maml:description> <maml:para>Gets information about one or more network adapters in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterNetworkInterface</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterNetworkInterface cmdlet gets information about one or more network adapters in a failover cluster. A failover cluster requires network connectivity among nodes and between clients and nodes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster network interface to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate the cluster network interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Network</maml:name> <maml:description> <maml:para>Specifies the name of the cluster network for which to enumerate the network interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node on which to enumerate the network interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate the cluster network interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster network interface to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Network</maml:name> <maml:description> <maml:para>Specifies the name of the cluster network for which to enumerate the network interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node on which to enumerate the network interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNetwork</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNetworkInterface</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterNetworkInterface Name Node Network State ---- ---- ------- ----- node1 - Local A ... node1 Cluster Network 1 Up node2 - Local A ... node2 Cluster Network 1 Up node1 - Local A ... node1 Cluster Network 2 Up node2 - Local A ... node2 Cluster Network 2 Up </dev:code> <dev:remarks> <maml:para>This example displays information about the physical network adapters used by the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterNode –Name node1 | Get-ClusterNetworkInterface Name Node Network State ---- ---- ------- ----- node1 - Local A ... node1 Cluster Network 1 Up node1 - Local A ... node1 Cluster Network 2 Up </dev:code> <dev:remarks> <maml:para>This example displays information about the physical network adapters used by node1 in the local cluster. This cmdlet is equivalent to Get-ClusterNetworkInterface -Node node1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321032</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterNode</command:name> <maml:description> <maml:para>Gets information about one or more nodes, or servers, in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterNode cmdlet gets information about one or more nodes, or servers, in a failover cluster.</maml:para> <maml:para>Use this cmdlet to obtain information about the node status. To see the resources currently owned by a particular node, specify that node in this cmdlet and then pipe the results through the Get-ClusterResource cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterNode</maml:name> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate cluster nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate cluster nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterNode Name ID State ---- -- ----- node1 1 Up node2 2 Up node3 3 Up node4 4 Up </dev:code> <dev:remarks> <maml:para>This example displays the name, id, and state of each node, or server, in the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterNode -Cluster cluster1 Name ID State ---- -- ----- node1 1 Up node2 2 Up </dev:code> <dev:remarks> <maml:para>This example displays the name, id, and state of each node, or server, in the cluster named cluster1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterNode –Name node1 | Get-ClusterResource Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 1 Online Cluster Group Physical Disk Cluster IP Address Online Cluster Group IP Address Cluster IP Addre... Online Cluster Group IPv6 Address Cluster Name Online Cluster Group Network Name File Share Witness Offline Cluster Group File Share Witness </dev:code> <dev:remarks> <maml:para>This example lists all cluster resources that are currently owned by node named node1 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321033</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterOwnerNode</command:name> <maml:description> <maml:para>Gets information about which nodes can own a resource in a failover cluster or information about the order of preference among owner nodes for a clustered role.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterOwnerNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterOwnerNode cmdlet gets information about which nodes can own a resource in a failover cluster or information about the order of preference among owner nodes for a clustered role.</maml:para> <maml:para>Settings that control the possible or preferred owners affect the way the cluster responds to the failure of a resource or a clustered role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterOwnerNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the cluster group for which owner nodes are enumerated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster group or cluster resource on which to enumerate owner nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="res"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which owner nodes are enumerated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="restype"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource type for which owner nodes are enumerated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the cluster group for which owner nodes are enumerated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster group or cluster resource on which to enumerate owner nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="res"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which owner nodes are enumerated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="restype"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource type for which owner nodes are enumerated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResourceType</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterOwnerNodeList</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Cluster "Cluster Disk 1" | Get-ClusterOwnerNode ClusterObject OwnerNodes ------------- ---------- Cluster Disk 1 {node1, node2} </dev:code> <dev:remarks> <maml:para>This example lists the possible owners for the cluster named Cluster Disk 1 in the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterGroup –Group cluster1FS12 | Get-ClusterOwnerNode ClusterObject OwnerNodes ------------- ---------- cluster1FS12 {} </dev:code> <dev:remarks> <maml:para>This example lists the preferred owners for the clustered file server, or resource group, called cluster1FS12 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321034</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ClusterOwnerNode</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterParameter</command:name> <maml:description> <maml:para>Gets detailed information about an object in a failover cluster, such as a cluster resource.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterParameter</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterParameter cmdlet gets detailed information about an object in a failover cluster, such as a cluster resource. This cmdlet is used to manage private properties for a cluster object. To get and set common properties for a cluster object, use the appropriate Get-Cluster* cmdlet to get the cluster object of interest and then set the property of interest on that cluster object directly.</maml:para> <maml:para>The type of detailed information you can obtain with this cmdlet depends on the cmdlet you combine with it. For example: -- If you use this cmdlet with the Get-ClusterResource cmdlet for a disk resource, then you can obtain the disk signature or GUID of a disk and information about whether maintenance is turned on for that disk. -- If you use this cmdlet with the Get-ClusterResource cmdlet for a Network Name resource, then you can obtain DNS-related information about the resource. -- If you use this cmdlet with the Get-ClusterResource cmdlet for an IP address resource, then you can obtain DHCP-related information about the IP Address resource. -- If you use this cmdlet with the Get-ClusterResource cmdlet for resources used by virtual machines, then you can obtain details about the settings for the virtual machines.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterParameter</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster parameter to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster object for which to get more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster object for which to get more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster parameter to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNetwork</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNetworkInterface</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResourceType</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterParameter</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name cluster1FS | Get-ClusterParameter Object Name Value Type ------ ---- ----- ---- cluster1FS Name cluster1FS String cluster1FS DnsName cluster1FS String cluster1FS RemapPipeNames 0 UInt32 cluster1FS HostRecordTTL 1200 UInt32 cluster1FS RegisterAllProvi... 0 UInt32 cluster1FS PublishPTRRecords 0 UInt32 cluster1FS TimerCallbackAdd... 5 UInt32 cluster1FS ResourceData {1, 0, 0, 0...} ByteArray cluster1FS StatusNetBIOS 0 UInt32 cluster1FS StatusDNS 0 UInt32 cluster1FS StatusKerberos 0 UInt32 cluster1FS CreatingDC \\DOMAIN12-DC-05... String cluster1FS LastDNSUpdateTime 10/15/2008 9:50:... DateTime cluster1FS ObjectGUID 8054680893fd5943... String </dev:code> <dev:remarks> <maml:para>This example gets the parameters, including the detailed information, for the cluster resource named cluster1FS on the local cluster. The displayed parameters will vary according to the type of resource being viewed.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name cluster1FS | Get-ClusterParameter –Name HostRecordTTL Object Name Value Type ------ ---- ----- ---- cluster1FS HostRecordTTL 1200 UInt32 </dev:code> <dev:remarks> <maml:para>This example displays the HostRecordTTL parameter for the cluster resource named cluster1FS on the local cluster, if that parameter is applicable to cluster1FS.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/p/?LinkId=321035</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ClusterParameter</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterQuorum</command:name> <maml:description> <maml:para>Gets information about the quorum configuration of a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterQuorum</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterQuorum cmdlet gets information about the quorum configuration of a failover cluster.</maml:para> <maml:para>The quorum configuration in a failover cluster determines the number of failures that the cluster can sustain. If an additional failure occurs, then the cluster must stop running. The relevant failures in this context are failures of nodes or, in some cases, of a disk witness (which contains a copy of the cluster configuration) or file share witness.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterQuorum</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster for which to query the quorum type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster for which to query the quorum type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterQuorumSettings</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterQuorum Cluster QuorumResource QuorumType ------- -------------- ---------- cluster1 Cluster Disk 1 NodeAndDiskMajority </dev:code> <dev:remarks> <maml:para>This example displays the quorum configuration for the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterQuorum -Cluster Cluster1 Cluster QuorumResource QuorumType ------- -------------- ---------- mycluster NodeMajority </dev:code> <dev:remarks> <maml:para>This example displays the quorum configuration for the cluster named Cluster1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321036</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ClusterQuorum</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterResource</command:name> <maml:description> <maml:para>Gets information about one or more resources in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterResource cmdlet gets information about one or more resources in a failover cluster.</maml:para> <maml:para>To set a common property for a clustered resource, use this cmdlet to get the object for the clustered resource, and then set the appropriate property on that object directly. To get and set more specific information about a clustered resource, use this cmdlet with Get-ClusterParameter and Set-ClusterParameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterResource</maml:name> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node or cluster group on which to enumerate cluster resources.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>VMId</maml:name> <maml:description> <maml:para>Specifies the virtual machine identifier (ID).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node or cluster group on which to enumerate cluster resources.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>VMId</maml:name> <maml:description> <maml:para>Specifies the virtual machine identifier (ID).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 1 Online Cluster Group Physical Disk Cluster Disk 2 Online Available Storage Physical Disk Cluster Disk 3 Online Available Storage Physical Disk Cluster Disk 4 Online Available Storage Physical Disk Cluster Disk 5 Online Available Storage Physical Disk Cluster Disk 6 Online Available Storage Physical Disk Cluster Disk 7 Online Available Storage Physical Disk Cluster IP Address Online Cluster Group IP Address Cluster IP Addre... Online Cluster Group IPv6 Address Cluster Name Online Cluster Group Network Name </dev:code> <dev:remarks> <maml:para>This example lists all cluster resources on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name "Cluster Disk 2" | Format-List –Property * Cluster : cluster1 IsCoreResource : False IsNetworkClassResource : False IsStorageClassResource : True OwnerNode : node2 ResourceType : Physical Disk State : Online OwnerGroup : Available Storage Name : Cluster Disk 2 MaintenanceMode : False MonitorProcessId : 524 Description : SeparateMonitor : False PersistentState : 1 LooksAlivePollInterval : 4294967295 IsAlivePollInterval : 4294967295 RestartAction : 2 RestartThreshold : 1 RestartDelay : 500 RestartPeriod : 900000 RetryPeriodOnFailure : 3600000 PendingTimeout : 180000 DeadlockTimeout : 300000 ResourceSpecificStatus : Id : 6e394089-145a-4279-b75d-b14015cc36e4 </dev:code> <dev:remarks> <maml:para>This example displays information about Cluster Disk 2, on the local cluster, in the form of a list.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name "Cluster Disk 2" | Get-ClusterParameter Object Name Value Type ------ ---- ----- ---- Cluster Disk 2 DiskIdType 0 UInt32 Cluster Disk 2 DiskSignature 2654136047 UInt32 Cluster Disk 2 DiskIdGuid String Cluster Disk 2 DiskRunChkDsk 0 UInt32 Cluster Disk 2 DiskUniqueIds {16, 0, 0, 0...} ByteArray Cluster Disk 2 DiskVolumeInfo {1, 0, 0, 0...} ByteArray Cluster Disk 2 DiskArbInterval 3 UInt32 Cluster Disk 2 DiskPath String Cluster Disk 2 DiskReload 0 UInt32 Cluster Disk 2 MaintenanceMode 0 UInt32 Cluster Disk 2 MaxIoLatency 1000 UInt32 Cluster Disk 2 CsvEnforseWriteT... 0 UInt32 Cluster Disk 2 DiskPnpUpdate {0, 0, 0, 0...} ByteArray </dev:code> <dev:remarks> <maml:para>This example displays detailed parameters for Cluster Disk 2 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterGroup –Name FileServer1 | Get-ClusterResource Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 1 Online FileServer1 Physical Disk Cluster IP Address Online FileServer1 IP Address Cluster IP Addre... Online FileServer1 IPv6 Address FileServer1 Online FileServer1 Network Name </dev:code> <dev:remarks> <maml:para>This example lists cluster resources in cluster group named FileServer1, a clustered file server on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 5</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name "Cluster Disk 2" | ForEach-Object –Process {$_.RestartDelay = 600} </dev:code> <dev:remarks> <maml:para>This example sets the common property RestartDelay for the Cluster Disk 2 resource on the local cluster to 600.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 6</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name "cluster pool 1" | Format-List -Property OwnerNode OwnerNode : cluster-node1 </dev:code> <dev:remarks> <maml:para>This example shows how to display the owner of a cluster pooled disk.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 7</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-ClusterResource –Name *print-VM1 | Get-VM | Stop-VM -Verbose VERBOSE: Current VMobject = Microsoft.HyperV.PowerShell.VirtualMachine[] VERBOSE: Stop-VM will shutdown the virtual machine "print-VM1". Confirm Hyper-V cannot shut down virtual machine print-VM1 because the Shutdown integration service is unavailable. To avoid potential data loss, you can pause or save the state of the virtual machine. The other option is to turn off the virtual machine, but data loss might occur. [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y </dev:code> <dev:remarks> <maml:para>This example enumerates the cluster resources for wildcard characters *print-VM1 and stops the corresponding virtual machines. Verbose mode is turned on for details of the operation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321037</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ForEach-Object</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Format-List</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterResourceDependency</command:name> <maml:description> <maml:para>Gets information about the dependencies that have been configured between clustered resources in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterResourceDependency</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterResourceDependency cmdlet gets information about the dependencies that have been configured between clustered resources in a failover cluster. Resource dependencies control the order in which resources are brought online or taken offline in the cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterResourceDependency</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which to get the dependency expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Guid</maml:name> <maml:description> <maml:para>Causes the generated dependency expression to have the resource GUIDs instead of the resource names.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource for which to get the dependency expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Guid</maml:name> <maml:description> <maml:para>Causes the generated dependency expression to have the resource GUIDs instead of the resource names.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource for which to get the dependency expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which to get the dependency expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResourceDependency</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResourceDependency –Resource cluster1FS12 Resource DependencyExpression -------- -------------------- cluster1FS12 [IP Address 172.24.11.0] or [IP Add ... </dev:code> <dev:remarks> <maml:para>This example displays the dependencies for the resource called cluster1FS12.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterGroup –Name cluster1FS12 | Get-ClusterResource | Get-ClusterResourceDependency Resource DependencyExpression -------- -------------------- cluster1FS12 [IP Address 172.24.11.0] or [IP Add ... Cluster Disk 6 IP Address 157.56.48.0 IP Address 2001:4898:9:2:: IP Address 2002:9d38:31ca:8:: </dev:code> <dev:remarks> <maml:para>This example displays the dependencies for each resource in the clustered file server ─resource group─ called cluster1FS12. Some resources do not have dependencies.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321038</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterResourceDependencyReport</command:name> <maml:description> <maml:para>Generates a report that lists the dependencies between resources in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterResourceDependencyReport</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterResourceDependencyReport cmdlet generates a report that lists the dependencies between resources in a failover cluster.</maml:para> <maml:para>The report has a filename extension of MHT. For convenience in storing and finding the report, you can pipe this cmdlet to the <maml:navigationLink><maml:linkText>Copy-Item</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet and specify a destination folder into which to copy the report.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterResourceDependencyReport</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the cluster group for which to generate the dependency report.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster group or cluster resource for which to create the dependency report.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which to generate the dependency report.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the cluster group for which to generate the dependency report.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster group or cluster resource for which to create the dependency report.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which to generate the dependency report.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResourceDependencyReport -Group cluster1FS12 Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 10/15/2008 6:29 PM 59299 fb509e66-8d02-4881-8184-6be5b1bfa4c2.mht </dev:code> <dev:remarks> <maml:para>This example creates a dependency report file for the clustered file server, or resource group, named cluster1FS12 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResourceDependencyReport -Group cluster1FS12 | Copy-Item -Destination C:\users\user1 </dev:code> <dev:remarks> <maml:para>This example creates a dependency report file for the clustered file server, or resource group, named cluster1FS12 on the local cluster. The dependency report is copied to C:\users\user1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterGroup | Get-ClusterResourceDependencyReport | Copy-Item -Destination \\fileserver\share </dev:code> <dev:remarks> <maml:para>This example creates a dependency report file for each clustered role, or resource group, on the local cluster, and copies all reports to \\fileserver\share.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321039</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-Item</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterResourceType</command:name> <maml:description> <maml:para>Gets information about one or more resource types in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterResourceType</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterResourceType cmdlet gets information about one or more resource types in a failover cluster. Obtain information such as the name of the dynamic-link library (DLL) through which the Cluster service communicates with a particular resource type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterResourceType</maml:name> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource type to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate the cluster resource types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate the cluster resource types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource type to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResourceType</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResourceType Name DisplayName ---- ----------- DFS Replicated Folder DFS Replicated Folder DHCP Service DHCP Service Distributed File System Distributed File System Distributed Transaction Coordinator Distributed Transaction Coordinator File Server File Server File Share Witness File Share Quorum Witness Generic Application Generic Application Generic Script Generic Script Generic Service Generic Service IP Address IP Address IPv6 Address IPv6 Address IPv6 Tunnel Address IPv6 Tunnel Address Microsoft iSNS iSNSClusRes MSMQ (Resource Type Unavailable) MSMQTriggers (Resource Type Unavailable) Network Name Network Name NFS Share NFS Share Physical Disk Physical Disk Print Spooler Print Spooler Virtual Machine Virtual Machine Virtual Machine Configuration Virtual Machine Configuration Volume Shadow Copy Service Task Volume Shadow Copy Service Task WINS Service WINS Service </dev:code> <dev:remarks> <maml:para>This example lists all the resource types that can be used in configurations on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResourceType –Name "File Server" | Format-List –Property * Cluster : Cluster1 DisplayName : File Server Name : file server DllName : clusres.dll Description : AdminExtensions : {} LooksAlivePollInterval : 5000 IsAlivePollInterval : 60000 PendingTimeout : 180000 DeadlockTimeout : 300000 Id : f582c84f-0066-0069-6c65-207365727665 </dev:code> <dev:remarks> <maml:para>This example gets information about the File Server resource type on the local cluster, and displays the information in the form of a list.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321040</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResourceType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResourceType</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterSharedVolume</command:name> <maml:description> <maml:para>Gets information about Cluster Shared Volumes in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterSharedVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterSharedVolume cmdlet gets information about Cluster Shared Volumes in a failover cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterSharedVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Cluster Shared Volume to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate the Cluster Shared Volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to enumerate the Cluster Shared Volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Cluster Shared Volume to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterSharedVolume Name State Node ---- ----- ---- Cluster Disk 3 Online node1 Cluster Disk 4 Online node2 </dev:code> <dev:remarks> <maml:para>This example lists all the Cluster Shared Volumes on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterSharedVolume -Cluster cluster1 Name State Node ---- ----- ---- Cluster Disk 1 Online node4 </dev:code> <dev:remarks> <maml:para>This example lists all the Cluster Shared Volumes on the cluster named cluster1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterSharedVolume –Name "Cluster Disk 4" Name State Node ---- ----- ---- Cluster Disk 4 Online node2 </dev:code> <dev:remarks> <maml:para>This example displays the state of the Cluster Shared Volume called Cluster Disk 4.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321041</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterSharedVolumeState</command:name> <maml:description> <maml:para>Gets the state of Cluster Shared Volumes in a cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterSharedVolumeState</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterSharedVolumeState cmdlet gets the state of Cluster Shared Volumes in a cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterSharedVolumeState</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the names, as a collection of strings, of the Cluster Shared Volumes for which to get state information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the name of the cluster on which to run this cmdlet. If you specify a period (.) or do not specify this parameter, the cmdlet runs on the local cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the names, as a collection of strings, of the cluster nodes for which to get the state of Cluster Shared Volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the name of the cluster on which to run this cmdlet. If you specify a period (.) or do not specify this parameter, the cmdlet runs on the local cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the names, as a collection of strings, of the Cluster Shared Volumes for which to get state information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the names, as a collection of strings, of the cluster nodes for which to get the state of Cluster Shared Volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster, Microsoft.FailoverClusters.PowerShell.ClusterNode, Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title> </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterSharedVolumeState Name : Cluster Disk X VolumeName : \\?\Volume{2297f079-53c2-41e9-94d1-483d61ea94d7}\ Node : ClusterNode1 State : Direct VolumeFriendlyName : Volume1 RedirectedIOReason : NotRedirected Name : Cluster Disk Y VolumeName : \\?\Volume{0312ef48-74c7-4a4d-946e-4bb4a397ad1f}\ Node : ClusterNode2 State : File System Redirected VolumeFriendlyName : Volume2 RedirectedIOReason : UserRequest Name : Cluster Disk Z VolumeName : \\?\Volume{c4689cef-83e3-4f47-9eaf-161a9e31c5a0}\ Node : ClusterNode3 State : Block Redirected VolumeFriendlyName : Volume3 RedirectedIOReason : NoDiskConnectivity </dev:code> <dev:remarks> <maml:para>This command gets the state of Cluster Shared Volumes on the local cluster. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321042</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClusterVMMonitoredItem</command:name> <maml:description> <maml:para>Gets the list of services and events currently being monitored in the virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ClusterVMMonitoredItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ClusterVMMonitoredItem cmdlet gets the list of services and events currently being monitored in the virtual machine. If one of those services fails or one of the events occurs, then the system responds by taking an action based on the failover configuration for the virtual machine resource. For example, the configuration might specify that the virtual machine be restarted.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClusterVMMonitoredItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>VirtualMachine</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine on which to perform monitoring. When this parameter is specified, the cmdlet must be run on one of the host cluster nodes, or else the Cluster parameter must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet or the clustered virtual machine for which to retrieve the clustered virtual machine monitored item object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Local Cluster</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet or the clustered virtual machine for which to retrieve the clustered virtual machine monitored item object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>VirtualMachine</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine on which to perform monitoring. When this parameter is specified, the cmdlet must be run on one of the host cluster nodes, or else the Cluster parameter must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterVMMonitoredItem</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Cluster –Name Cluster1 | Get-ClusterVMMonitoredItem –VirtualMachine vm1 Name ---- Microsoft-Windows-FailoverClustering-Manager+Admin,Microsoft-Windows-FailoverClustering-Manager,4708 Spooler </dev:code> <dev:remarks> <maml:para>This example returns the services and events being monitored in the virtual machine named vm1 on the cluster named Cluster1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321043</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterVMMonitoredItem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterVMMonitoredItem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-ClusterVMMonitoredState</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Grant-ClusterAccess</command:name> <maml:description> <maml:para>Grants access to a failover cluster, either full access or read-only access.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Grant</command:verb> <command:noun>ClusterAccess</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Grant-ClusterAccess cmdlet grants access to a failover cluster, either full access or read-only access. To provide someone with read-only access to the cluster, use the ReadOnly parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Grant-ClusterAccess</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user for whom to grant cluster access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Full</maml:name> <maml:description> <maml:para>Specifies that the user gets full cluster access. If no access level is specified, then the user gets read-only cluster access.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to grant access for the given user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Specifies that the user gets read-only cluster access. If no access level is specified, then the user gets read-only cluster access.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Full</maml:name> <maml:description> <maml:para>Specifies that the user gets full cluster access. If no access level is specified, then the user gets read-only cluster access.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to grant access for the given user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Specifies that the user gets read-only cluster access. If no access level is specified, then the user gets read-only cluster access.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user for whom to grant cluster access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Grant-ClusterAccess –User contoso\johnj99 -Full </dev:code> <dev:remarks> <maml:para>This example grants full access to the local cluster to johnj99 in the contoso domain.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Grant-ClusterAccess –User contoso\johnj99 -ReadOnly </dev:code> <dev:remarks> <maml:para>This example grants read-only access to the local cluster to johnj99 in the contoso domain.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321044</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Block-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Move-ClusterGroup</command:name> <maml:description> <maml:para>Moves a clustered role (a resource group) from one node to another in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>ClusterGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Move-ClusterGroup cmdlet moves a clustered role (a resource group) from one node to another in a failover cluster.</maml:para> <maml:para>Moving a resource group is a way of simulating failover. Running this cmdlet is also an appropriate step to take in preparation for routine maintenance on a node.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-ClusterGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the resource group to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to which to move the resource group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the resource group to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the resource group to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the resource group to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to which to move the resource group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Move-ClusterGroup –Name MyFileServer Name OwnerNode State ---- --------- ----- MyFileServer node1 Online </dev:code> <dev:remarks> <maml:para>This example moves the clustered service called MyFileServer from the current owner node to any other node.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Move-ClusterGroup –Name MyFileServer -Node node2 Name OwnerNode State ---- --------- ----- MyFileServer node2 Online </dev:code> <dev:remarks> <maml:para>This example moves the resource group called MyFileServer from the current owner node to the node named node2.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterNode node3 | Get-ClusterGroup | Move-ClusterGroup Name OwnerNode State ---- --------- ----- Available Storage node4 Online Cluster Group node1 Online MyFileServer node1 Online </dev:code> <dev:remarks> <maml:para>This example moves all resource groups that are currently owned by the node named node3 to other nodes. Use this cmdlet before performing maintenance on the specified node.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Move-ClusterGroup –Name MyFileServer -Node node2 -Wait 0 Name OwnerNode State ---- --------- ----- MyFileServer node2 Pending </dev:code> <dev:remarks> <maml:para>This example moves the resource group called MyFileServer from the current owner node to the node named node2. Information about MyFileServer is displayed immediately, while it is in the process of being moved.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321045</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Move-ClusterResource</command:name> <maml:description> <maml:para>Moves a clustered resource from one clustered role to another within a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>ClusterResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Move-ClusterResource cmdlet moves a clustered resource from one clustered role to another within a failover cluster. When a clustered resource is moved to a different clustered role, the clustered resource will then fail over with that clustered role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-ClusterResource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the cluster group to which to move the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the cluster group to which to move the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Move-ClusterResource –Name resource1 –Group group2 Name State Group ResourceType ---- ----- ----- ------------ resource1 Offline group2 IP Address </dev:code> <dev:remarks> <maml:para>This command moves the cluster resource called resource1 to the resource group called group2 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321046</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Move-ClusterSharedVolume</command:name> <maml:description> <maml:para>Moves a Cluster Shared Volume (CSV) to ownership by a different node in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>ClusterSharedVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Move-ClusterSharedVolume cmdlet moves a Cluster Shared Volume (CSV) to ownership by a different node in a failover cluster.</maml:para> <maml:para>On a failover cluster that uses CSVs, at any given time, access to each CSV is controlled by a particular node, called the owner of that CSV. However, a single CSV can contain virtual hard disk (VHD) files used by multiple clustered virtual machines that are distributed across multiple cluster nodes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-ClusterSharedVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Cluster Shared Volume to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to which to move the Cluster Shared Volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the Cluster Shared Volume to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the Cluster Shared Volume to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Cluster Shared Volume to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to which to move the Cluster Shared Volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Move-ClusterSharedVolume –Name "Cluster Disk 3" Name State Node ---- ----- ---- Cluster Disk 3 Online node2 </dev:code> <dev:remarks> <maml:para>This example moves the Cluster Shared Volume called Cluster Disk 3 to another cluster node.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Move-ClusterSharedVolume –Name "Cluster Disk 3" -Node node1 Name State Node ---- ----- ---- Cluster Disk 3 Online node1 </dev:code> <dev:remarks> <maml:para>This example moves the Cluster Shared Volume called Cluster Disk 3 to the node named node1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321047</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Repair-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Move-ClusterVirtualMachineRole</command:name> <maml:description> <maml:para>Moves the ownership of a clustered virtual machine to a different node.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>ClusterVirtualMachineRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Move-ClusterVirtualMachineRole cmdlet moves the ownership of a clustered virtual machine to a different node.</maml:para> <maml:para>This cmdlet is used to live migrate a clustered virtual machine. For quick migration, use Move-ClusterGroup after using Get-ClusterResource and Set-ClusterParameter to set the OfflineAction parameter of the virtual machine resource to save state, or a value of 1.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-ClusterVirtualMachineRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to which to move the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cancel</maml:name> <maml:description> <maml:para>Specifies that an in-progress live migration of the virtual machine be canceled.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered virtual machine to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MigrationType</maml:name> <maml:description> <maml:para>Specifies the type of migration to perform for the virtual machine. The options are as follows: -- Live: Transparently migrates the virtual machine without a dropped network connection or perceived downtime. -- Quick: Rapidly migrates a running virtual machine with minimal downtime. -- Shutdown: Performs an orderly shutdown of the operating system (waiting for all processes to close) on the virtual machine, and then migrates the virtual machine. -- ShutdownForce: Shuts down the operating system on the virtual machine without waiting for slower processes to finish, and then migrates the virtual machine. -- TurnOff: Turns off the virtual machine without shutting down the operating system first, then migrates the virtual machine. This is the same as turning off the power, which means that data loss may occur. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NativeGroupHelp.VmMigrationType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>VMId</maml:name> <maml:description> <maml:para>Specifies the virtual machine identifier (ID).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cancel</maml:name> <maml:description> <maml:para>Specifies that an in-progress live migration of the virtual machine be canceled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered virtual machine to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MigrationType</maml:name> <maml:description> <maml:para>Specifies the type of migration to perform for the virtual machine. The options are as follows: -- Live: Transparently migrates the virtual machine without a dropped network connection or perceived downtime. -- Quick: Rapidly migrates a running virtual machine with minimal downtime. -- Shutdown: Performs an orderly shutdown of the operating system (waiting for all processes to close) on the virtual machine, and then migrates the virtual machine. -- ShutdownForce: Shuts down the operating system on the virtual machine without waiting for slower processes to finish, and then migrates the virtual machine. -- TurnOff: Turns off the virtual machine without shutting down the operating system first, then migrates the virtual machine. This is the same as turning off the power, which means that data loss may occur. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NativeGroupHelp.VmMigrationType</command:parameterValue> <dev:type> <maml:name>NativeGroupHelp.VmMigrationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to which to move the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>VMId</maml:name> <maml:description> <maml:para>Specifies the virtual machine identifier (ID).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Move-ClusterVirtualMachineRole –Name "Virtual Machine1" -Node node2 Name OwnerNode State ---- --------- ----- Virtual Machine1 node2 Online </dev:code> <dev:remarks> <maml:para>This example performs a live migration of the clustered virtual machine named Virtual Machine1 to the node named node2. The Windows PowerShell® prompt does not return until the action is complete.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterGroup –Name "Virtual Machine1" | Move-ClusterVirtualMachineRole -Node node2 -Wait 0 Name OwnerNode State ---- --------- ----- Virtual Machine1 node2 Online </dev:code> <dev:remarks> <maml:para>This example performs a live migration of clustered virtual machine named Virtual Machine1 to the node named node2. The Windows PowerShell® prompt returns as soon as the action has been initiated.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Move-ClusterVirtualMachineRole –Name "Virtual Machine1" -Cancel Name OwnerNode State ---- --------- ----- Virtual Machine1 node1 Online </dev:code> <dev:remarks> <maml:para>This example cancels the live migration in progress for the clustered virtual machine named Virtual Machine1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$groups = Get-ClusterNode –Name node1 | Get-ClusterGroup | Where-Object –FilterScript {$_ | Get-ClusterResource | Where-Object –FilterScript {$_.ResourceType -Like "Virtual Machine"}} PS C:\>ForEach-Object -InputObject ($group in $groups) -Process { $group | Move-ClusterVirtualMachineRole -Node node2 } Name OwnerNode State ---- --------- ----- Virtual Machine1 node2 Online Virtual Machine2 node2 Online Virtual Machine3 node2 Online </dev:code> <dev:remarks> <maml:para>This example performs a live migration of all clustered virtual machines that are currently owned by the node named node1 to the node named node2. The migration of each virtual machine should complete before the next migration is started. Use this cmdlet before performing maintenance on the specified node.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/p/?LinkId=321048</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterVirtualMachineRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-ClusterVirtualMachineConfiguration</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-Cluster</command:name> <maml:description> <maml:para>Creates a new failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>Cluster</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-Cluster cmdlet creates a new failover cluster. Before creating a cluster, the hardware (servers, networks, and storage) must be connected, and the validation tests must be run.</maml:para> <maml:para>Use Test-Cluster to run the validation tests. The tests will confirm that the hardware and settings are compatible with failover clustering. There are multiple types of tests, including Inventory, System Configuration, Network, Storage, and other types of tests.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-Cluster</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="aap"> <maml:name>AdministrativeAccessPoint</maml:name> <maml:description> <maml:para>Specifies the type of administrative access point that the cmdlet creates for the cluster. The acceptable values for this parameter are: -- ActiveDirectoryAndDns. The cmdlet creates an administrative access point for the cluster. The administrative access point is registered in DNS and enabled in Active Directory Domain Services. -- Dns. The cmdlet creates an administrative access point for the cluster. The administrative access point is registered in DNS but is not enabled in Active Directory Domain Services. -- None. The cmdlet does not create an administrative access point for the cluster. Some clustered roles and functionality might not be available for a cluster that does not have an administrative access point. Also, you cannot use Failover Cluster Manager to manage a cluster that does not have an administrative access point.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ActiveDirectoryAndDns</command:parameterValue> <command:parameterValue required="true" variableLength="false">Dns</command:parameterValue> <command:parameterValue required="true" variableLength="false">None</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies a comma-separated list of cluster node names, or server names, on which to create the cluster. If this parameter is not specified, then a one node cluster is created on the local physical computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NoStorage</maml:name> <maml:description> <maml:para>Specifies that shared storage is ignored during the cluster creation. The cluster created at the end of the operation will not have shared storage. Shared storage can later be added by piping the ClusterDiskInfo object from the Get-ClusterAvailableDisk cmdlet into the Add-ClusterDisk cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="aap"> <maml:name>AdministrativeAccessPoint</maml:name> <maml:description> <maml:para>Specifies the type of administrative access point that the cmdlet creates for the cluster. The acceptable values for this parameter are: -- ActiveDirectoryAndDns. The cmdlet creates an administrative access point for the cluster. The administrative access point is registered in DNS and enabled in Active Directory Domain Services. -- Dns. The cmdlet creates an administrative access point for the cluster. The administrative access point is registered in DNS but is not enabled in Active Directory Domain Services. -- None. The cmdlet does not create an administrative access point for the cluster. Some clustered roles and functionality might not be available for a cluster that does not have an administrative access point. Also, you cannot use Failover Cluster Manager to manage a cluster that does not have an administrative access point.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AdminAccessPoint</command:parameterValue> <dev:type> <maml:name>AdminAccessPoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreNetwork</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NoStorage</maml:name> <maml:description> <maml:para>Specifies that shared storage is ignored during the cluster creation. The cluster created at the end of the operation will not have shared storage. Shared storage can later be added by piping the ClusterDiskInfo object from the Get-ClusterAvailableDisk cmdlet into the Add-ClusterDisk cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies a comma-separated list of cluster node names, or server names, on which to create the cluster. If this parameter is not specified, then a one node cluster is created on the local physical computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticAddress</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-Cluster -Name cluster1 -Node node1,node2,node3,node4 Name ---- cluster1 </dev:code> <dev:remarks> <maml:para>This example creates a four-node cluster named cluster1, using default settings for IP addressing.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-Cluster -Name cluster1 -Node node1,node2 -NoStorage Name ---- cluster1 </dev:code> <dev:remarks> <maml:para>This example creates a two-node cluster named cluster1. The cluster will not have any clustered storage, or disk resources. Storage can be added using the Get-ClusterAvailableDisk cmdlet with the Add-ClusterDisk cmdlet.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123 Name ---- cluster1 </dev:code> <dev:remarks> <maml:para>This example creates a four-node cluster named cluster1 that uses the static IP address 2.0.0.123.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123,3.0.0.123 Name ---- cluster1 </dev:code> <dev:remarks> <maml:para>This example creates a four-node cluster named cluster1 that uses the static IP addresses 2.0.0.123 and 3.0.0.123.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 5</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -IgnoreNetwork 2.0.0.0/8 Name ---- cluster1 </dev:code> <dev:remarks> <maml:para>This example creates a four-node cluster named cluster1. The cluster uses default settings for IP addressing, and does not use the network 2.0.0.0/8.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 6</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123 -IgnoreNetwork 3.0.0.0/8 Name ---- cluster1 </dev:code> <dev:remarks> <maml:para>This example creates a four-node cluster named cluster1. The cluster uses the static IP address 2.0.0.123, and does not use the network 3.0.0.0/8.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321049</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-Cluster</command:name> <maml:description> <maml:para>Destroys an existing failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>Cluster</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-Cluster cmdlet destroys an existing failover cluster. The affected servers will no longer function together as a cluster.</maml:para> <maml:para>This cmdlet deletes all copies of the cluster configuration database on all cluster nodes.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-Cluster</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CleanupAD</maml:name> <maml:description> <maml:para>Specifies that when the cluster is destroyed, the objects in Active Directory that are associated with the cluster are removed.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster to destroy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CleanupAD</maml:name> <maml:description> <maml:para>Specifies that when the cluster is destroyed, the objects in Active Directory that are associated with the cluster are removed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster to destroy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-Cluster </dev:code> <dev:remarks> <maml:para>This example prompts the user for confirmation, then destroys the local failover cluster and removes cluster configuration information from the cluster nodes.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-Cluster -Force </dev:code> <dev:remarks> <maml:para>This example destroys the local failover cluster and removes cluster configuration information from the cluster nodes. The cmdlet does not prompt for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Cluster –Name Cluster1 | Remove-Cluster -Force -CleanupAD </dev:code> <dev:remarks> <maml:para>This example destroys the cluster named Cluster1, removes cluster configuration information from the cluster nodes, and deletes the cluster objects in Active Directory. The cmdlet does not prompt for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321050</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ClusterAccess</command:name> <maml:description> <maml:para>Removes a user from the access list on the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ClusterAccess</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ClusterAccess cmdlet removes a user from the access list on the cluster. After this cmdlet is run, the user might still have access to the cluster if the user account is part of another user group which is on the cluster access list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ClusterAccess</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user for which to remove cluster access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster from which to remove access for the given user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster from which to remove access for the given user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user for which to remove cluster access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterAccess –User contoso\johnj99 </dev:code> <dev:remarks> <maml:para>This example removes the user johnj99 in the contoso domain from the access list of the local cluster. After this cmdlet runs, the user might still have access to the cluster if the user is part of another user group granted access to the cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321051</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Block-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Grant-ClusterAccess</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ClusterCheckpoint</command:name> <maml:description> <maml:para>Removes a cryptographic key checkpoint or registry checkpoint for a resource.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ClusterCheckpoint</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ClusterCheckpoint cmdlet removes a cryptographic key checkpoint or registry checkpoint for a resource.</maml:para> <maml:para>Checkpoints help provide failover support for applications that store configuration information locally instead of or in addition to storing information in the cluster configuration database. Applications might store information locally in two ways. One way is to store configuration information in the registry on the local server; another way is to use cryptographic keys on the local server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ClusterCheckpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the resource from which a checkpoint should be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckpointName</maml:name> <maml:description> <maml:para>Specifies the name of the checkpoint to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CryptoCheckpoint</maml:name> <maml:description> <maml:para>Specifies that cryptographic key checkpoints will be removed.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet or the cluster resource from which to remove the checkpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RegistryCheckpoint</maml:name> <maml:description> <maml:para>Specifies that registry checkpoints will be removed.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckpointName</maml:name> <maml:description> <maml:para>Specifies the name of the checkpoint to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CryptoCheckpoint</maml:name> <maml:description> <maml:para>Specifies that cryptographic key checkpoints will be removed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet or the cluster resource from which to remove the checkpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RegistryCheckpoint</maml:name> <maml:description> <maml:para>Specifies that registry checkpoints will be removed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the resource from which a checkpoint should be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-ClusterResource "Cluster Name" | Remove-ClusterCheckpoint -RegistryCheckpoint PS C:\>Remove-ClusterCheckpoint Are you sure you want to remove registry checkpoint 'software\clusname' on resource 'Cluster Name'? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y </dev:code> <dev:remarks> <maml:para>This example removes the registry checkpoint called software\clusname for the resource named Cluster Name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321052</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterCheckpoint</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterCheckpoint</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ClusterGroup</command:name> <maml:description> <maml:para>Removes a clustered role, also called a resource group, from a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ClusterGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ClusterGroup cmdlet removes a clustered role. also called a resource group, from a failover cluster.</maml:para> <maml:para>Use this cmdlet to delete a group. If the group still has resources in it, then either remove the resources first, or specify the RemoveResources parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ClusterGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered role to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered role to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RemoveResources</maml:name> <maml:description> <maml:para>Causes the cmdlet to delete all resources in the clustered role before removing the clustered role.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered role to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered role to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RemoveResources</maml:name> <maml:description> <maml:para>Causes the cmdlet to delete all resources in the clustered role before removing the clustered role.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterGroup –Name MyFileServer </dev:code> <dev:remarks> <maml:para>This example prompts the user for confirmation and then removes the clustered role named MyFileServer, if the resources have first been removed from it.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterGroup –Name MyFileServer -Force </dev:code> <dev:remarks> <maml:para>This example removes the clustered role named MyFileServer, if the resources have first been removed from it. The cmdlet does not prompt for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterGroup –Name MyFileServer -Force -RemoveResources </dev:code> <dev:remarks> <maml:para>This example removes the clustered role named MyFileServer, without prompting for confirmation. All cluster resources in MyFileServer will be deleted.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321053</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ClusterNode</command:name> <maml:description> <maml:para>Removes a node from a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ClusterNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ClusterNode cmdlet removes a node from a failover cluster. After the node is removed, the node no longer functions as part of the cluster unless the node is added back to the cluster. Removing a node is also called evicting a node from the cluster.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ClusterNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterNode –Name node4 </dev:code> <dev:remarks> <maml:para>This example removes the node named node4 from the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterNode –Name node4 -Force </dev:code> <dev:remarks> <maml:para>This example removes the node named node4 from the local cluster without prompting for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321054</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ClusterResource</command:name> <maml:description> <maml:para>Removes a clustered resource from the failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ClusterResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ClusterResource cmdlet removes a clustered resource from the failover cluster. Before removing a resource, be sure to review whether any other resource is dependent on that resource.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ClusterResource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterResource –Name "Cluster Disk 4" </dev:code> <dev:remarks> <maml:para>This example prompts the user for confirmation and then deletes the cluster named Cluster Disk 4 from the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterResource –Name "Cluster Disk 5" -Force </dev:code> <dev:remarks> <maml:para>This example deletes the cluster named Cluster Disk 5 from the local cluster without prompting for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321055</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ClusterResourceDependency</command:name> <maml:description> <maml:para>Removes a dependency between two resources in a clustered role within a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ClusterResourceDependency</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ClusterResourceDependency cmdlet removes a dependency between two resources in a clustered role within a failover cluster.</maml:para> <maml:para>A dependent resource is brought online after the resources on which it depends. Likewise, a dependent resource is taken offline before the resources on which it depends. If no dependency is configured between clustered resources, then the order in which they are brought online or taken offline might vary.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ClusterResourceDependency</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource from which to remove the dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specifies the cluster resource on which to remove a dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource from which to remove the dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource from which to remove the dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specifies the cluster resource on which to remove a dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource from which to remove the dependency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterResourceDependency -Resource cluster1FS -Provider "IP Address 2001:4898:9:2:: (3)" Name State Group ResourceType ---- ----- ----- ------------ cluster1FS Online cluster1FS Network Name </dev:code> <dev:remarks> <maml:para>This example removes the dependency between cluster resource cluster1FS and the resource named IP Address 2001:4898:9:2:: (3).</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name cluster1FS | Remove-ClusterResourceDependency –Provider "IP Address 2001:4898:9:2:: (3)" Name State Group ResourceType ---- ----- ----- ------------ cluster1FS Online cluster1FS Network Name </dev:code> <dev:remarks> <maml:para>This example removes the dependency between the cluster resource named cluster1FS and the resource named IP Address 2001:4898:9:2:: (3).</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321056</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ClusterResourceType</command:name> <maml:description> <maml:para>Removes a resource type from a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ClusterResourceType</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ClusterResourceType cmdlet removes a resource type from a failover cluster. A resource type is a class of resource, such as physical disk, network name, or virtual machine, that is organized by the failover cluster. After a resource type is removed from a failover cluster, resources of that type will not be able to be used in the cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ClusterResourceType</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource type to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource type to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource type to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource type to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResourceType</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterResourceType –Name ResType1 </dev:code> <dev:remarks> <maml:para>This example removes the registered resource type named ResType1 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321057</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResourceType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResourceType</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ClusterSharedVolume</command:name> <maml:description> <maml:para>Removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ClusterSharedVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ClusterSharedVolume cmdlet removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster. After placing a volume in Available Storage, you can use the volume when you configure a new clustered role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ClusterSharedVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Cluster Shared Volume to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the Cluster Shared Volume to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the Cluster Shared Volume to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Cluster Shared Volume to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterSharedVolume –Name "Cluster Disk 3" Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 3 Online Available Storage Physical Disk </dev:code> <dev:remarks> <maml:para>This example removes the CSV named Cluster Disk 3 from the Cluster Shared Volumes on the local cluster, and places it in Available Storage.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterSharedVolume –Name "Cluster Disk 4" | Remove-ClusterSharedVolume Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 4 Online Available Storage Physical Disk </dev:code> <dev:remarks> <maml:para>This example removes the CSV named Cluster Disk 4 from the Cluster Shared Volumes on the local cluster, and places it in Available Storage.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321058</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ClusterVMMonitoredItem</command:name> <maml:description> <maml:para>Removes monitoring of a service or event that is currently being monitored on a virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ClusterVMMonitoredItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ClusterVMMonitoredItem cmdlet removes monitoring of a service or event that is currently being monitored. After removal, if the service fails or the event occurs, the system will no longer take an action, such as restarting the virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ClusterVMMonitoredItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>VirtualMachine</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine from which to remove monitoring. When this parameter is specified, this cmdlet must be run on one of the host cluster nodes, or else the Cluster parameter must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the event identifier (ID) of the Event Tracing for Windows (ETW) event to be removed from monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventLog</maml:name> <maml:description> <maml:para>Specifies the event log of the event to be removed from monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventSource</maml:name> <maml:description> <maml:para>Specifies the event source of the event to be removed from monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet, the clustered virtual machine from which to remove monitoring, or the clustered virtual machine monitored item object to stop monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies the name of the service to be removed from monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the event identifier (ID) of the Event Tracing for Windows (ETW) event to be removed from monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventLog</maml:name> <maml:description> <maml:para>Specifies the event log of the event to be removed from monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventSource</maml:name> <maml:description> <maml:para>Specifies the event source of the event to be removed from monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet, the clustered virtual machine from which to remove monitoring, or the clustered virtual machine monitored item object to stop monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies the name of the service to be removed from monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>VirtualMachine</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine from which to remove monitoring. When this parameter is specified, this cmdlet must be run on one of the host cluster nodes, or else the Cluster parameter must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterVMMonitoredItem</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterVMMonitoredItem -VirtualMachine VM1 | Remove-ClusterVMMonitoredItem -VirtualMachine VM1 </dev:code> <dev:remarks> <maml:para>This example removes all of the items being monitored on the virtual machine named VM1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-ClusterVMMonitoredItem -VirtualMachine VM1 -Service spooler </dev:code> <dev:remarks> <maml:para>This example removes monitoring on the print spooler service on the virtual machine named VM1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?linkid=321059</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterVMMonitoredItem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterVMMonitoredItem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-ClusterVMMonitoredState</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Repair-ClusterSharedVolume</command:name> <maml:description> <maml:para>Runs repair tools on a Cluster Shared Volume locally on a cluster node.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Repair</command:verb> <command:noun>ClusterSharedVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Repair-ClusterSharedVolume cmdlet runs repair tools on a Cluster Shared Volume locally on a cluster node.</maml:para> <maml:para>This cmdlet runs chkdsk.exe or defrag.exe on a Cluster Shared Volume. It will turn maintenance on for the volume, move the cluster resource to the node running this cmdlet, run the tool, and then turn maintenance off for the volume. This cmdlet has to run locally on one of the cluster nodes. To run remotely, use Windows PowerShell® remoting.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Repair-ClusterSharedVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Specifies the name of the volume on which to run the tool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies one or more parameters to pass through to the tool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChkDsk</maml:name> <maml:description> <maml:para>Specifies that chkdsk.exe is run on the volume. Any parameters specified in the Parameters parameter will be passed through to chkdsk.exe.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Repair-ClusterSharedVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Specifies the name of the volume on which to run the tool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies one or more parameters to pass through to the tool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Defrag</maml:name> <maml:description> <maml:para>Specifies that defrag.exe is run on the volume. Any parameters specified in the Parameters parameter will be passed through to defrag.exe.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChkDsk</maml:name> <maml:description> <maml:para>Specifies that chkdsk.exe is run on the volume. Any parameters specified in the Parameters parameter will be passed through to chkdsk.exe.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Defrag</maml:name> <maml:description> <maml:para>Specifies that defrag.exe is run on the volume. Any parameters specified in the Parameters parameter will be passed through to defrag.exe.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies one or more parameters to pass through to the tool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Specifies the name of the volume on which to run the tool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Repair-ClusterSharedVolume –VolumeName C:\ClusterStorage\Volume1 -Defrag </dev:code> <dev:remarks> <maml:para>This example runs defrag.exe on Cluster Shared Volume located at C:\ClusterStorage\Volume1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Repair-ClusterSharedVolume –VolumeName C:\ClusterStorage\Volume1 -ChkDsk -Parameters "/F" </dev:code> <dev:remarks> <maml:para>This example runs chkdsk.exe on Cluster Shared Volume located at C:\ClusterStorage\Volume1 and passes the /F parameter to chkdsk.exe.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321060</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterSharedVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-ClusterVMMonitoredState</command:name> <maml:description> <maml:para>Resets the Application Critical state of a virtual machine, so that the virtual machine is no longer marked as being in a critical state in the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>ClusterVMMonitoredState</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Reset-ClusterVMMonitoredState cmdlet resets the Application Critical state of a virtual machine, so that the virtual machine is no longer marked as being in a critical state in the cluster. Note: This cmdlet can only be run locally on the virtual machine or through Windows PowerShell® remoting to the virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-ClusterVMMonitoredState</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>VirtualMachine</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine to reset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet and the clustered virtual machine to reset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the cmdlet and the clustered virtual machine to reset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>VirtualMachine</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine to reset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Reset-ClusterVMMoniteredState </dev:code> <dev:remarks> <maml:para>This example resets the state of the virtual machine and clears the critical state.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/p/?LinkId=321061</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterVMMonitoredItem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterVMMonitoredItem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterVMMonitoredItem</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-ClusterNode</command:name> <maml:description> <maml:para>Resumes a node from the paused state or brings back drained workloads to the node or both.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resume</command:verb> <command:noun>ClusterNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Resume-ClusterNode cmdlet resumes activity on a failover cluster node after it has been suspended, or paused, or brings back drained workloads to the node, or both. When a node is resumed, clustered roles that were drained from the node are returned to it, and clustered roles or resources that are currently offline can be brought online on that node.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resume-ClusterNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the group, node, resource, or service for which or cluster on which to run the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Failback</maml:name> <maml:description> <maml:para>Sets the policy to bring back drained workloads to the node. The acceptable values for this parameter are: NoFailback, Immediate, and Policy. Policy can be configured to not failback, failback immediately, or failback only during specific hours.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResumeClusterNodeFailbackType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the group, node, resource, or service for which or cluster on which to run the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Failback</maml:name> <maml:description> <maml:para>Sets the policy to bring back drained workloads to the node. The acceptable values for this parameter are: NoFailback, Immediate, and Policy. Policy can be configured to not failback, failback immediately, or failback only during specific hours.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResumeClusterNodeFailbackType</command:parameterValue> <dev:type> <maml:name>ResumeClusterNodeFailbackType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the group, node, resource, or service for which or cluster on which to run the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the group, node, resource, or service for which or cluster on which to run the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Resume-ClusterNode node1 Name State ---- ----- node1 Up </dev:code> <dev:remarks> <maml:para>This example resumes node1 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Resume-ClusterNode node2 -Cluster mycluster Name State ---- ----- node2 Up </dev:code> <dev:remarks> <maml:para>This example resumes node2 on the cluster called mycluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterNode | Resume-ClusterNode Name State ---- ----- node1 Up </dev:code> <dev:remarks> <maml:para>This example resumes all cluster nodes that are suspended, or paused, on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterNode | Resume-ClusterNode -Failback Immediate Name State ---- ----- node2 Up </dev:code> <dev:remarks> <maml:para>This example resumes all cluster nodes that are suspended, or paused, on the local cluster and immediately brings back the workloads drained from the nodes.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321062</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-ClusterResource</command:name> <maml:description> <maml:para>Turns off maintenance for a disk resource or Cluster Shared Volume within a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resume</command:verb> <command:noun>ClusterResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Resume-ClusterResource cmdlet turns off maintenance for a disk resource or Cluster Shared Volume within a failover cluster.</maml:para> <maml:para>This cmdlet applies to disks and Cluster Shared Volumes only. We recommend that maintenance be turned off for a disk or Cluster Shared Volume as soon as the maintenance tasks have been completed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resume-ClusterResource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to resume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource to resume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Specifies the name of the volume to suspend. This parameter is only applicable to Cluster Shared Volumes. If this parameter is not specified, then the operation will be performed on all volumes on the Cluster Shared Volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource to resume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to resume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Specifies the name of the volume to suspend. This parameter is only applicable to Cluster Shared Volumes. If this parameter is not specified, then the operation will be performed on all volumes on the Cluster Shared Volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Resume-ClusterResource "Cluster Disk 2" Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 2 Online Available Storage Physical Disk </dev:code> <dev:remarks> <maml:para>This example turns off maintenance for the CSV named Cluster Disk 2.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterSharedVolume "Cluster Disk 5" | Resume-ClusterResource Name State Node ---- ----- ---- Cluster Disk 5 Online node2 </dev:code> <dev:remarks> <maml:para>This example turns off maintenance for all volumes on the CSV named Cluster Disk 5.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321063</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ClusterLog</command:name> <maml:description> <maml:para>Sets the size and level of detail for the cluster log.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>ClusterLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-ClusterLog cmdlet sets the size and level of detail for the cluster log. The default level, 3, includes errors, warnings, and additional information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ClusterLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster from which to generate cluster logs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Level</maml:name> <maml:description> <maml:para>Specifies the log level to set for the cluster. The acceptable values for this parameter are: 0 to 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Size</maml:name> <maml:description> <maml:para>Specifies the log size to set for the cluster. The acceptable values for this parameter are: 8 MB to 1024 MB.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster from which to generate cluster logs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Level</maml:name> <maml:description> <maml:para>Specifies the log level to set for the cluster. The acceptable values for this parameter are: 0 to 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Size</maml:name> <maml:description> <maml:para>Specifies the log size to set for the cluster. The acceptable values for this parameter are: 8 MB to 1024 MB.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Set-ClusterLog -Level 1 Name ---- cluster1 </dev:code> <dev:remarks> <maml:para>This example sets the cluster log to a detail level of 1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Set-ClusterLog -Size 1024 Name ---- cluster1 </dev:code> <dev:remarks> <maml:para>This example sets the cluster log size to 1024 MB.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321064</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterLog</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ClusterOwnerNode</command:name> <maml:description> <maml:para>Specifies which nodes can own a resource in a failover cluster or specifies the order of preference among owner nodes for a clustered role, or resource group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>ClusterOwnerNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-ClusterOwnerNode cmdlet specifies which nodes can own a resource in a failover cluster or specifies the order of preference among owner nodes for a clustered role, or resource group. The settings that control the possible or preferred owners affect the way the cluster responds to the failure of a resource or a clustered role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ClusterOwnerNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the cluster group for which owner nodes are set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster group or cluster resource for which to set owner nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which owner nodes are set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies the list of owner nodes. If this is for a cluster group, then the sorted list of nodes is the preferred owners for this cluster group. If this is for a cluster resource, then the list is for the possible owners for this cluster resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the cluster group for which owner nodes are set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster group or cluster resource for which to set owner nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies the list of owner nodes. If this is for a cluster group, then the sorted list of nodes is the preferred owners for this cluster group. If this is for a cluster resource, then the list is for the possible owners for this cluster resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which owner nodes are set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name "Cluster Disk 3" | Set-ClusterOwnerNode -Owners node1,node2 </dev:code> <dev:remarks> <maml:para>This example sets the possible owners for cluster named Cluster Disk 3 on the local cluster to the nodes named node1 and node2.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Set-ClusterOwnerNode -Group cluster12FS -Owners node3,node2 </dev:code> <dev:remarks> <maml:para>This example sets the preferred owners for the clustered service named cluster12FS to the node named node3 followed by the node named node2 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321065</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterOwnerNode</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ClusterParameter</command:name> <maml:description> <maml:para>Controls specific properties of an object in a failover cluster, such as a resource, a group, or a network.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>ClusterParameter</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-ClusterParameter cmdlet controls specific properties of an object in a failover cluster, such as a resource, a group, or a network. -- For a disk resource, you can set the disk signature or GUID of a disk, and turn maintenance on or off for that disk. -- For a Network Name resource, you can set DNS-related information about the resource. -- For an IP address resource, you can set DHCP-related information about the IP Address resource. -- For resources used by virtual machines, you can set details about the settings for the virtual machines. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ClusterParameter</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster parameter to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value to be set for the cluster parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Create</maml:name> <maml:description> <maml:para>Causes the cmdlet to create the parameter on the cluster object, if it does not already exist.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Delete</maml:name> <maml:description> <maml:para>Causes the cmdlet to delete the parameter from the cluster object.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster object for which to set the parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Multiple</maml:name> <maml:description> <maml:para>Allows multiple cluster parameters to be set simultaneously. These parameters are provided in the form of a hashtable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Create</maml:name> <maml:description> <maml:para>Causes the cmdlet to create the parameter on the cluster object, if it does not already exist.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Delete</maml:name> <maml:description> <maml:para>Causes the cmdlet to delete the parameter from the cluster object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster object for which to set the parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Multiple</maml:name> <maml:description> <maml:para>Allows multiple cluster parameters to be set simultaneously. These parameters are provided in the form of a hashtable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster parameter to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value to be set for the cluster parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNetwork</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNetworkInterface</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterParameter</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResourceType</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name cluster1FS | Set-ClusterParameter –Name HostRecordTTL –Value 300 </dev:code> <dev:remarks> <maml:para>This example configures the clustered resource called cluster1FS on the local cluster, by setting the value of HostRecordTTL to 300.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name "Cluster IP Address" | Set-ClusterParameter -Multiple @{"Address"="172.24.22.168";"Network"="Cluster Network 2";"EnableDhcp"=1} </dev:code> <dev:remarks> <maml:para>This example uses the Multiple parameter to configure the clustered resource called Cluster IP Address, by setting the Address, Network, and EnableDhcp parameters simultaneously.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$res = Get-ClusterResource –Name "IP Address" PS C:\>$param1 = New-Object –ComObject Microsoft.FailoverClusters.PowerShell.ClusterParameter –Property $res,Address,10.55.88.46 PS C:\>$param2 = New-Object –ComObject Microsoft.FailoverClusters.PowerShell.ClusterParameter –Property $res,SubnetMask,255.0.0.0 PS C:\>$params = $param1,$param2 PS C:\>$params | Set-ClusterParameter </dev:code> <dev:remarks> <maml:para>This example configures the clustered resource called IP Address to use a new static IP. Because the new address and subnet mask are required, both parameters must be passed to this cmdlet together.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/p/?LinkId=321066</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterParameter</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ClusterQuorum</command:name> <maml:description> <maml:para>Configures quorum options for a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>ClusterQuorum</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-ClusterQuorum cmdlet configures quorum options for a failover cluster. The quorum configuration in a failover cluster determines the number of failures that the cluster can sustain. If an additional failure occurs, the cluster must stop running. The relevant failures in this context are failures of nodes or, in some cases, of a disk witness (which contains a copy of the cluster configuration) or file share witness.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ClusterQuorum</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DiskOnly</maml:name> <maml:description> <maml:para>Causes the cluster quorum to be set to disk only type. This is not recommended as it creates a single point of failure for the cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NodeAndDiskMajority"> <maml:name>DiskWitness</maml:name> <maml:description> <maml:para>Specifies the name of the disk resource that the cluster quorum uses as the disk witness. Specifying this parameter sets the cluster quorum to the Node and Disk Majority type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NodeAndFileShareMajority"> <maml:name>FileShareWitness</maml:name> <maml:description> <maml:para>Specifies the path of the file share that the cluster quorum uses as the file witness. Specifying this parameter sets the cluster quorum to the Node and File Share Majority type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to change the quorum type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NodeMajority"> <maml:name>NoWitness</maml:name> <maml:description> <maml:para>Indicates that the cmdlet sets the cluster quorum to the Node Majority type.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DiskOnly</maml:name> <maml:description> <maml:para>Causes the cluster quorum to be set to disk only type. This is not recommended as it creates a single point of failure for the cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NodeAndDiskMajority"> <maml:name>DiskWitness</maml:name> <maml:description> <maml:para>Specifies the name of the disk resource that the cluster quorum uses as the disk witness. Specifying this parameter sets the cluster quorum to the Node and Disk Majority type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NodeAndFileShareMajority"> <maml:name>FileShareWitness</maml:name> <maml:description> <maml:para>Specifies the path of the file share that the cluster quorum uses as the file witness. Specifying this parameter sets the cluster quorum to the Node and File Share Majority type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to change the quorum type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NodeMajority"> <maml:name>NoWitness</maml:name> <maml:description> <maml:para>Indicates that the cmdlet sets the cluster quorum to the Node Majority type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterQuorumSettings</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Set-ClusterQuorum -NodeMajority Cluster QuorumResource QuorumType ------- -------------- ---------- cluster1 NodeMajority </dev:code> <dev:remarks> <maml:para>This example changes the quorum configuration to Node Majority on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Set-ClusterQuorum -NodeAndDiskMajority "Cluster Disk 7" Cluster QuorumResource QuorumType ------- -------------- ---------- cluster1 Cluster Disk 7 NodeAndDiskMajority </dev:code> <dev:remarks> <maml:para>This example changes the quorum configuration to Node and Disk Majority on the local cluster, using the disk resource named Cluster Disk 7 for the disk witness.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Set-ClusterQuorum -NodeAndFileShareMajority \\fileserver\fsw Cluster QuorumResource QuorumType ------- -------------- ---------- cluster1 File Share Witness NodeAndFileShareMajority </dev:code> <dev:remarks> <maml:para>This example changes the quorum configuration to Node and File Share Majority on the local cluster, using the disk resource at \\fileserver\fsw for the file share witness.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321067</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterQuorum</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ClusterResourceDependency</command:name> <maml:description> <maml:para>Specifies the resources that a particular resource depends on within a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>ClusterResourceDependency</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-ClusterResourceDependency cmdlet specifies the resources that a particular resource depends on within a failover cluster. Existing dependencies will be overwritten by the dependencies that you specify.</maml:para> <maml:para>The term or can be used in the expression describing the dependency. For example, an or dependency can be set up where a Network Name resource is dependent on either of two IP address resources, instead of being dependent on both. This use of or dependencies is common in multi-site cluster deployments.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ClusterResourceDependency</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which to set the dependency expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Dependency</maml:name> <maml:description> <maml:para>Specifies the dependency expression to set for this resource. The format for this is string is as follows. "[Resource Name 1] [and|or [Resource Name 2] [...] ]" Resource names should be enclosed in square brackets as [Cluster Disk 2]. To reset the resource dependency, use an empty string "" in this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource for which to set the dependency expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Dependency</maml:name> <maml:description> <maml:para>Specifies the dependency expression to set for this resource. The format for this is string is as follows. "[Resource Name 1] [and|or [Resource Name 2] [...] ]" Resource names should be enclosed in square brackets as [Cluster Disk 2]. To reset the resource dependency, use an empty string "" in this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource for which to set the dependency expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource for which to set the dependency expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Set-ClusterResourceDependency –Resource cluster1FS12 -Dependency "[IP Address 151.56.48.0]" </dev:code> <dev:remarks> <maml:para>This example makes the resource called cluster1FS12 dependent on [IP Address 151.56.48.0].</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\PS>Set-ClusterResourceDependency –Resource cluster1FS12 –Dependency "[IP Address 151.56.48.0] or [New IP Address]" </dev:code> <dev:remarks> <maml:para>This example makes the resource called cluster1FS12 dependent on either [IP Address 151.56.48.0] or [New IP Address].</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\PS>Set-ClusterResourceDependency –Resource cluster1FS12 –Dependency "" </dev:code> <dev:remarks> <maml:para>This example clears the dependency list for the resource named cluster1FS12, so that it no longer depends on any other resources.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321068</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResourceDependencyReport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResourceDependency</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-Cluster</command:name> <maml:description> <maml:para>Starts the Cluster service on all nodes of the cluster on which it is not yet started.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>Cluster</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-Cluster cmdlet starts the Cluster service on all nodes of the cluster on which it is not yet started. A node can function as part of the cluster only when the Cluster service is running on that node.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-Cluster</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IPS"> <maml:name>IgnorePersistentState</maml:name> <maml:description> <maml:para>Starts the nodes in the cluster without bringing resources online on the nodes.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>Specifies the time in seconds to wait for the cmdlet. If this parameter is not specified, then the cmdlet will not return until quorum is achieved. If the value of 0 is specified, the cmdlet will attempt to start the Cluster service on all nodes and then return without waiting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IPS"> <maml:name>IgnorePersistentState</maml:name> <maml:description> <maml:para>Starts the nodes in the cluster without bringing resources online on the nodes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>Specifies the time in seconds to wait for the cmdlet. If this parameter is not specified, then the cmdlet will not return until quorum is achieved. If the value of 0 is specified, the cmdlet will attempt to start the Cluster service on all nodes and then return without waiting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Start-Cluster Name ---- mycluster </dev:code> <dev:remarks> <maml:para>This example starts all cluster nodes on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Start-Cluster –Name node2 Name ---- mycluster </dev:code> <dev:remarks> <maml:para>This example starts all cluster nodes on the cluster of which the node named node2 is a part. A node name is required if all cluster nodes are stopped. If the cluster is already running, then the cluster name, assuming the cluster name resource is online, can be used instead of the node name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321069</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-ClusterGroup</command:name> <maml:description> <maml:para>Starts one or more clustered roles, also known as resource groups, on a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>ClusterGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-ClusterGroup cmdlet starts one or more clustered roles, also known as resource groups, on a failover cluster. With this cmdlet, a clustered role can be started again after stopping it for maintenance or diagnosis.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-ClusterGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered role to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered role to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered role to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered role to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Start-ClusterGroup FileServer1 Name OwnerNode State ---- --------- ----- FileServer1 node1 Online </dev:code> <dev:remarks> <maml:para>This example starts the clustered file server, or resource group, called FileServer1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Start-ClusterGroup FileServer1 -Wait 0 Name OwnerNode State ---- --------- ----- FileServer1 node1 Pending </dev:code> <dev:remarks> <maml:para>This example starts the clustered file server, or resource group, called FileServer1. The Windows PowerShell® prompt returns as soon as the action has been initiated.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321070</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-ClusterNode</command:name> <maml:description> <maml:para>Starts the Cluster service on a node in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>ClusterNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-ClusterNode cmdlet starts the Cluster service on a node in a failover cluster. If this is the first node started, then it will wait for other nodes to join. The cluster will begin to run when a quorum has formed.</maml:para> <maml:para>This cmdlet with the FixQuorum parameter can be used to force quorum, that is, force the start of a cluster node even if quorum has not been achieved. When quorum is forced on a given node, the copy of the cluster configuration that is on that node will be treated as the authoritative copy and will be replicated to all other nodes. Therefore, forcing quorum should be considered a last resort, because some cluster configuration changes could be lost. The ability to force quorum can be especially useful in a multi-site cluster if the primary site, with the majority of nodes, becomes unavailable, and the secondary site, with a minority of nodes, need to be brought into service. Similarly, the ability to force quorum makes it possible to start a cluster that uses the Node and File Share Majority quorum option when none of the available cluster nodes contains a current copy of the cluster configuration.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-ClusterNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="fq,FixQuorum"> <maml:name>ForceQuorum</maml:name> <maml:description> <maml:para>Indicates that the cmdlet forces the start of a cluster node regardless if quorum is not formed.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ips"> <maml:name>IgnorePersistentState</maml:name> <maml:description> <maml:para>Starts the cluster node without bringing resources online on the node.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="pq"> <maml:name>PreventQuorum</maml:name> <maml:description> <maml:para>Starts the node, but prevents it from achieving quorum and forming the cluster, to prevent a split situation with two competing instances of the cluster running.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="fq,FixQuorum"> <maml:name>ForceQuorum</maml:name> <maml:description> <maml:para>Indicates that the cmdlet forces the start of a cluster node regardless if quorum is not formed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ips"> <maml:name>IgnorePersistentState</maml:name> <maml:description> <maml:para>Starts the cluster node without bringing resources online on the node.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="pq"> <maml:name>PreventQuorum</maml:name> <maml:description> <maml:para>Starts the node, but prevents it from achieving quorum and forming the cluster, to prevent a split situation with two competing instances of the cluster running.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Start-ClusterNode –Name node3 Name State ---- ----- node3 Joining </dev:code> <dev:remarks> <maml:para>This example starts the Cluster service on the node named node3 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Start-ClusterNode –Name node1 -Cluster cluster2 Name State ---- ----- node1 Joining </dev:code> <dev:remarks> <maml:para>This example starts the Cluster service on the node named node1 on the cluster named cluster2.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Start-ClusterNode -FixQuorum Name State ---- ----- node1 Joining </dev:code> <dev:remarks> <maml:para>This example forces the local node and the local cluster to start, even if quorum has not been achieved. If quorum has not been achieved, then the copy of the cluster configuration that is on the local node will be treated as the authoritative copy and will be replicated to all other nodes. This cmdlet should be considered a last resort, because some cluster configuration changes could be lost.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321071</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-ClusterResource</command:name> <maml:description> <maml:para>Brings a resource online in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>ClusterResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-ClusterResource cmdlet brings a resource online in a failover cluster. Before the resource is brought online, any resources that it depends are brought online.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-ClusterResource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to bring online. This can also be the name of a Cluster Shared Volume (CSV).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource to bring online.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource to bring online.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to bring online. This can also be the name of a Cluster Shared Volume (CSV).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Start-ClusterResource –Name "IP Address 172.24.11.0" Name State Group ResourceType ---- ----- ----- ------------ IP Address 172.2... Online cluster1FS12 IP Address </dev:code> <dev:remarks> <maml:para>This example brings the resource called IP Address 172.24.11.0 online on the local cluster. Before bringing the resource online, this cmdlet brings online any resources on which the resource depends.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Start-ClusterResource –Name "IP Address 172.24.11.0" -Wait 0 Name State Group ResourceType ---- ----- ----- ------------ IP Address 172.2... OnlinePending cluster1FS12 IP Address </dev:code> <dev:remarks> <maml:para>This example brings the resource called IP Address 172.24.11.0 online on the local cluster. Before bringing the resource online, this cmdlet brings online any resources on which the resource depends. The Windows PowerShell® prompt returns as soon as the action has been initiated.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321072</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-Cluster</command:name> <maml:description> <maml:para>Stops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>Cluster</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Stop-Cluster cmdlet stops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster. A node can only function as part of the cluster when the Cluster service is running on that node.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-Cluster</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-Cluster</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Stop-Cluster </dev:code> <dev:remarks> <maml:para>This example stops the Cluster service on all nodes in the local cluster, which will stop all services and applications configured in the cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Stop-Cluster cluster1 </dev:code> <dev:remarks> <maml:para>This example stops the Cluster service on all nodes in the cluster named cluster1, which will stop all services and applications configured in the cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321073</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-ClusterGroup</command:name> <maml:description> <maml:para>Stops one or more clustered roles, also known as resource groups, on a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>ClusterGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Stop-ClusterGroup cmdlet stops one or more clustered roles, also known as resource groups, on a failover cluster.</maml:para> <maml:para>If maintenance on a clustered role is needed, the clustered role can be stopped in an orderly fashion by using this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-ClusterGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered role to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered role to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered role to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered role to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterGroup</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Stop-ClusterGroup FileServer1 Name OwnerNode State ---- --------- ----- FileServer1 node1 Offline </dev:code> <dev:remarks> <maml:para>This example stops the clustered role, or resource group, called FileServer1 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321074</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-ClusterNode</command:name> <maml:description> <maml:para>Stops the Cluster service on a node in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>ClusterNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Stop-ClusterNode cmdlet stops the Cluster service on a node in a failover cluster. If stopping the node brings the cluster below quorum, the operation is not permitted. To stop the cluster, use the Stop-Cluster cmdlet instead.</maml:para> <maml:para>Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-ClusterNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to stop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Stop-ClusterNode –Name node3 Name State ---- ----- node3 Down </dev:code> <dev:remarks> <maml:para>This example stops the Cluster service on the node named node3 of the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Stop-ClusterNode –Name node1 -Cluster cluster2 Name State ---- ----- node1 Down </dev:code> <dev:remarks> <maml:para>This example stops the Cluster service on the node named node1 on the cluster named cluster2.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321075</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-ClusterResource</command:name> <maml:description> <maml:para>Takes a resource offline in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>ClusterResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Stop-ClusterResource cmdlet takes a resource offline in a failover cluster. Before the resource is taken offline, any resources that depend on it are taken offline.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-ClusterResource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to take offline. This can also be the name of a Cluster Shared Volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource to take offline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IgnoreLocked</maml:name> <maml:description> <maml:para>Specifies that locked groups are ignored when running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource to take offline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource to take offline. This can also be the name of a Cluster Shared Volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Stop-ClusterResource "IP Address 172.24.11.0" Name State Group ResourceType ---- ----- ----- ------------ IP Address 172.2... Offline cluster1FS12 IP Address </dev:code> <dev:remarks> <maml:para>This example takes the resource called IP Address 172.24.11.0 offline on the local cluster. Before taking the resource offline, it takes offline any dependent resources.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321076</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Suspend-ClusterNode</command:name> <maml:description> <maml:para>Suspends activity on a failover cluster node, that is, pauses the node.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Suspend</command:verb> <command:noun>ClusterNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Suspend-ClusterNode cmdlet suspends activity on a failover cluster node, that is, pauses the node. If you use the Drain parameter, clustered roles currently running on the node will be drained before the node is paused.</maml:para> <maml:para>Pausing (suspending) a node is usually done when applying software updates to the node. If you need to perform extensive diagnosis or maintenance on a cluster node, it might be more workable to stop (not pause) the Cluster service on that node.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Suspend-ClusterNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to suspend (with or without draining).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>TargetNode</maml:name> <maml:description> <maml:para>Specifies a node to which to drain the workloads.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Drain</maml:name> <maml:description> <maml:para>Specifies that all of the workloads are gracefully moved to other nodes while maintaining the highest levels of availability and using the best placement logic.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceEvacuation</maml:name> <maml:description> <maml:para>Specifies that workloads are moved from a node even in the case of an error.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node to suspend (with or without draining), or the cluster on which to run the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Drain</maml:name> <maml:description> <maml:para>Specifies that all of the workloads are gracefully moved to other nodes while maintaining the highest levels of availability and using the best placement logic.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceEvacuation</maml:name> <maml:description> <maml:para>Specifies that workloads are moved from a node even in the case of an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster node to suspend (with or without draining), or the cluster on which to run the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster node to suspend (with or without draining).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>TargetNode</maml:name> <maml:description> <maml:para>Specifies a node to which to drain the workloads.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Wait</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Suspend-ClusterNode node1 Name State ---- ----- node1 Paused </dev:code> <dev:remarks> <maml:para>This example pauses the node named node1 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Suspend-ClusterNode node2 -Cluster cluster2 Name State ---- ----- node2 Paused </dev:code> <dev:remarks> <maml:para>This example pauses the node named node2 on the cluster named cluster2.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Suspend-ClusterNode -Name node1 -Target node2 -Drain Name State ---- ----- node1 Paused </dev:code> <dev:remarks> <maml:para>This example pauses the node named node1 and moves the workloads from it to the node named node2.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Suspend-ClusterNode node1 -Drain -Whatif What if: Performing operation "Suspend-ClusterNode" on Target "node1". </dev:code> <dev:remarks> <maml:para>This example provides a preview of the operation that will be performed on the node named node1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321077</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Suspend-ClusterResource</command:name> <maml:description> <maml:para>Turns on maintenance for a disk resource or Cluster Shared Volume (CSV) so that you can run a disk maintenance tool without triggering failover.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Suspend</command:verb> <command:noun>ClusterResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Suspend-ClusterResource cmdlet turns on maintenance for a disk resource or Cluster Shared Volume (CSV) so that a disk maintenance tool can be run without triggering failover.</maml:para> <maml:para>This cmdlet only applies to disks and CSVs. For Cluster Shared Volumes, turning on maintenance takes dependent resources offline, which interrupts client access. For other disks (LUNs) in cluster storage, turning on maintenance leaves dependent resources online.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Suspend-ClusterResource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource, a disk or CSV, to suspend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource, a disk or CSV, to suspend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RedirectedAccess</maml:name> <maml:description> <maml:para>Causes CSV access to the storage device to be redirected over the network through another cluster node. This parameter is only applicable to CSVs.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Specifies the name of the volume to suspend. This parameter is only applicable to Cluster Shared Volumes (CSVs). If this parameter is not specified, then the operation will be performed on all volumes on the CSV.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource, a disk or CSV, to suspend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource, a disk or CSV, to suspend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RedirectedAccess</maml:name> <maml:description> <maml:para>Causes CSV access to the storage device to be redirected over the network through another cluster node. This parameter is only applicable to CSVs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Specifies the name of the volume to suspend. This parameter is only applicable to Cluster Shared Volumes (CSVs). If this parameter is not specified, then the operation will be performed on all volumes on the CSV.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Suspend-ClusterResource –Name "Cluster Disk 2" Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 2 Online(Maintenance) Available Storage Physical Disk </dev:code> <dev:remarks> <maml:para>This example turns on maintenance for CSV named Cluster Disk 2 so that you can run a disk maintenance tool without triggering failover.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterSharedVolume –Name "Cluster Disk 5" | Suspend-ClusterResource Name State Node ---- ----- ---- Cluster Disk 5 Online node2 </dev:code> <dev:remarks> <maml:para>This example turns on maintenance for all volumes on the CSV named Cluster Disk 5.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321078</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-Cluster</command:name> <maml:description> <maml:para>Runs validation tests for failover cluster hardware and settings.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>Cluster</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-Cluster cmdlet runs validation tests for failover cluster hardware and settings. Tests can be run both before and after a cluster is set up.</maml:para> <maml:para>Test results are captured in a file with the file name that you specify. By running the validation tests, you can confirm that your hardware and settings are compatible with Failover Clustering. There are multiple types of tests, including Cluster, Inventory, Network, Storage, System, and other types of tests. Storage tests will not test online disks or storage pools that are in use by a clustered role. To test such disks, first run Stop-ClusterGroup to stop the clustered role, and then run Test-Cluster. After the tests are done, start the clustered roles, also known as resource groups, again.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-Cluster</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies a comma-separated list of server names on which to run the cluster validation tests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Disk</maml:name> <maml:description> <maml:para>Specifies the disk number or disks for which to run the cmdlet. If the specified disk is online and is assigned to a clustered role or Cluster Shared Volume, you must also specify the Force parameter to take the disk offline for the duration of the storage tests. Otherwise, the specified disk must be offline before the cmdlet is run. If the Disk parameter is not specified, storage tests run on all disks that are available for use in the cluster or that are in the cluster resource offline or failed state. The acceptable values for this parameter are: -- Int32, Int64, Uint32, Uint64: A number that represents a master boot record (MBR) signature of the disk. -- System.String: A string that represents a master boot record (MBR) signature of the disk, hexadecimal format is supported. -- System.String: A string that represents the GUID of a GPT disk. -- ClusterResource: A cluster resource object that represents a clustered disk. -- CimInstance#MSFT_Disk: An object returned from Get-Disk, from the Windows PowerShell® storage module. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Ignore</maml:name> <maml:description> <maml:para>Specifies which tests or category of tests to ignore during the validation test run. All others tests or category of tests will run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Include</maml:name> <maml:description> <maml:para>Specifies which tests or category of tests to include during the validation test run. Only the tests or category of tests specified here will run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the validation tests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>List</maml:name> <maml:description> <maml:para>Causes the cmdlet to list the tests and test categories. No tests will run on the servers or cluster nodes.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Pool</maml:name> <maml:description> <maml:para>Specifies the clustered storage pool or pools for which to run the cmdlet. When the specified storage pool is online and a virtual disk in the storage pool is assigned to a clustered role or Cluster Shared Volume, you must also specify the Force parameter to take the storage pool offline for the duration of the storage tests. Otherwise, the specified storage pool must be taken offline before the storage tests. If the Pool parameter is not specified, storage tests run on all storage pools that are available for use in the cluster or that are in the cluster resource offline or failed state. The acceptable values for this parameter are: -- System.String: A string that represents the name of the clustered storage pool or pools. -- ClusterResource: A cluster resource object that represents a clustered storage pool. -- CimInstance#MSFT_StoragePool: An object returned from Get-StoragePool, from the Windows PowerShell storage module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ReportName</maml:name> <maml:description> <maml:para>Specifies the name of the test report to generate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Disk</maml:name> <maml:description> <maml:para>Specifies the disk number or disks for which to run the cmdlet. If the specified disk is online and is assigned to a clustered role or Cluster Shared Volume, you must also specify the Force parameter to take the disk offline for the duration of the storage tests. Otherwise, the specified disk must be offline before the cmdlet is run. If the Disk parameter is not specified, storage tests run on all disks that are available for use in the cluster or that are in the cluster resource offline or failed state. The acceptable values for this parameter are: -- Int32, Int64, Uint32, Uint64: A number that represents a master boot record (MBR) signature of the disk. -- System.String: A string that represents a master boot record (MBR) signature of the disk, hexadecimal format is supported. -- System.String: A string that represents the GUID of a GPT disk. -- ClusterResource: A cluster resource object that represents a clustered disk. -- CimInstance#MSFT_Disk: An object returned from Get-Disk, from the Windows PowerShell® storage module. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Ignore</maml:name> <maml:description> <maml:para>Specifies which tests or category of tests to ignore during the validation test run. All others tests or category of tests will run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Include</maml:name> <maml:description> <maml:para>Specifies which tests or category of tests to include during the validation test run. Only the tests or category of tests specified here will run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster on which to run the validation tests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>List</maml:name> <maml:description> <maml:para>Causes the cmdlet to list the tests and test categories. No tests will run on the servers or cluster nodes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies a comma-separated list of server names on which to run the cluster validation tests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Pool</maml:name> <maml:description> <maml:para>Specifies the clustered storage pool or pools for which to run the cmdlet. When the specified storage pool is online and a virtual disk in the storage pool is assigned to a clustered role or Cluster Shared Volume, you must also specify the Force parameter to take the storage pool offline for the duration of the storage tests. Otherwise, the specified storage pool must be taken offline before the storage tests. If the Pool parameter is not specified, storage tests run on all storage pools that are available for use in the cluster or that are in the cluster resource offline or failed state. The acceptable values for this parameter are: -- System.String: A string that represents the name of the clustered storage pool or pools. -- ClusterResource: A cluster resource object that represents a clustered storage pool. -- CimInstance#MSFT_StoragePool: An object returned from Get-StoragePool, from the Windows PowerShell storage module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ReportName</maml:name> <maml:description> <maml:para>Specifies the name of the test report to generate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.Cluster</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterTestInfo</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Test-Cluster Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 10/10/2008 6:31 PM 1132255 Test-Cluster on 2008.10.10 At 18.22.53.mht </dev:code> <dev:remarks> <maml:para>This example runs all applicable cluster validation tests on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Test-Cluster -Node node1,node2 Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 10/10/2008 6:18 PM 998032 Test-Cluster on 2008.10.10 At 18.08.24.mht </dev:code> <dev:remarks> <maml:para>This example runs all cluster validation tests on the nodes named node1 and node2. If either node1 or node2 is already a member of a cluster, then the tests will include all nodes in that cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Test-Cluster -List Category DisplayName Description -------- ----------- ----------- Cluster Configuration List Cluster Core Groups List information about the available... Cluster Configuration List Cluster Network Information List cluster-specific network settin... Cluster Configuration List Cluster Resources List the resources that are configur... Cluster Configuration List Cluster Volumes List information for the volumes in ... Cluster Configuration List Clustered Roles List information about clustered roles. Cluster Configuration Validate Quorum Configuration Validate that the current quorum con... Cluster Configuration Validate Resource Status Validate that cluster resources are ... Cluster Configuration Validate Service Principal Name Validate that a Service Principal Na... Cluster Configuration Validate Volume Consistency If any volumes are flagged as incons... Hyper-V Configuration List Information About Servers Runni... List Hyper-V related information on ... Hyper-V Configuration Validate Compatibility of Virtual Fi... Validate that all specified nodes sh... Hyper-V Configuration Validate Hyper-V Memory Resource Poo... Validate that all specified nodes sh... Hyper-V Configuration Validate Hyper-V Network Resource Po... Validate that all specified nodes sh... Hyper-V Configuration Validate Hyper-V Processor Resource ... Validate that all specified nodes sh... Hyper-V Configuration Validate Hyper-V Role Installed Validate that all the nodes have the... Hyper-V Configuration Validate Hyper-V Storage Resource Po... Validate that all specified nodes sh... Hyper-V Configuration Validate Matching Processor Manufact... Validate that all specified nodes sh... Hyper-V Configuration List Hyper-V Virtual Machine Informa... List Hyper-V virtual machine informa... Hyper-V Configuration Validate Hyper-V Integration Service... Validate that the Hyper-V integratio... Hyper-V Configuration Validate Hyper-V Virtual Machine Net... Validate that all virtual machines o... Hyper-V Configuration Validate Hyper-V Virtual Machine Sto... Validate that all virtual machines o... Inventory List Fibre Channel Host Bus Adapters List Fibre Channel host bus adapters... Inventory List iSCSI Host Bus Adapters List iSCSI host bus adapters on each... Inventory List SAS Host Bus Adapters List Serial Attached SCSI (SAS) host... Inventory List BIOS Information List BIOS information from each node. Inventory List Environment Variables List environment variables set on ea... Inventory List Memory Information List memory information for each node. Inventory List Operating System Information List information about the operating... Inventory List Plug and Play Devices List Plug and Play devices on each n... Inventory List Running Processes List the running processes on each n... Inventory List Services Information List information about the services ... Inventory List Software Updates List software updates that have been... Inventory List System Drivers List the system drivers on each node. Inventory List System Information List system information such as comp... Inventory List Unsigned Drivers List the unsigned drivers on each node. Network List Network Binding Order List the order in which networks are... Network Validate Cluster Network Configuration Validate the cluster networks that w... Network Validate IP Configuration Validate that IP addresses are uniqu... Network Validate Multiple Subnet Properties For clusters using multiple subnets,... Network Validate Network Communication Validate that servers can communicat... Network Validate Windows Firewall Configuration Validate that the Windows Firewall i... Storage List Disks List all disks visible to one or mor... Storage List Potential Cluster Disks List disks that will be validated fo... Storage Validate CSV Network Bindings Validate that network bindings requi... Storage Validate CSV Settings Validate that settings and configura... Storage Validate Disk Access Latency Validate acceptable latency for disk... Storage Validate Disk Arbitration Validate that a node that owns a dis... Storage Validate Disk Failover Validate that a disk can fail over s... Storage Validate File System Validate that the file system on dis... Storage Validate Microsoft MPIO-based disks Validate that disks that use Microso... Storage Validate Multiple Arbitration Validate that in a multiple-node arb... Storage Validate SCSI device Vital Product D... Validate uniqueness of inquiry data ... Storage Validate SCSI-3 Persistent Reservation Validate that storage supports the S... Storage Validate Simultaneous Failover Validate that disks can fail over si... System Configuration Validate Active Directory Configuration Validate that all the nodes have the... System Configuration Validate All Drivers Signed Validate that tested servers contain... System Configuration Validate Cluster Service and Driver ... Validate startup settings used by se... System Configuration Validate Memory Dump Settings Validate that none of the nodes curr... System Configuration Validate Operating System Edition Validate that all tested servers are... System Configuration Validate Operating System Installati... Validate that the operating systems ... System Configuration Validate Operating System Version Validate that the operating systems ... System Configuration Validate Required Services Validate that services required for ... System Configuration Validate Same Processor Architecture Validate that all servers run as 64-... System Configuration Validate Service Pack Levels Validate that all servers with same ... System Configuration Validate Software Update Levels Validate that all tested servers hav... System Configuration Validate System Drive Variable Validate that all nodes have the sam... </dev:code> <dev:remarks> <maml:para>This example lists the names of all tests and categories in cluster validation. Specify these test names with Ignore or Include parameters to run specific tests.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Test-Cluster -Node node1,node2 -Include Storage Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 10/10/2008 6:20 PM 37818 Test-Cluster on 2008.10.10 At 18.20.52.mht </dev:code> <dev:remarks> <maml:para>This example runs the storage validation tests on the nodes named node1 and node2. If either node1 or node2 is already a member of a cluster, then the tests will include all nodes in that cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Test-Cluster -Node node1,node2 -Ignore Inventory Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 10/10/2008 6:20 PM 732889 Test-Cluster on 2008.10.10 At 18.19.47.mht </dev:code> <dev:remarks> <maml:para>This example runs all validation tests except the Inventory tests on the nodes named node1 and node2. If either node1 or node2 is already a member of a cluster, then the tests will include all nodes in that cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 6</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Test-Cluster -Include "List Potential Cluster Disks" Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 10/15/2008 2:58 PM 36119 Test-Cluster on 2008.10.15 At 14.58.44.mht </dev:code> <dev:remarks> <maml:para>This example runs the test called List Potential Cluster Disks on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 7</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Test-Cluster -Include "List System Drivers","List Unsigned Drivers" Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 10/15/2008 3:00 PM 266571 Test-Cluster on 2008.10.15 At 15.00.08.mht </dev:code> <dev:remarks> <maml:para>This example runs the tests called List System Drivers and List Unsigned Drivers on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/p/?LinkId=321079</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-Cluster</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-ClusterResourceFailure</command:name> <maml:description> <maml:para>Simulates a failure of a cluster resource.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>ClusterResourceFailure</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-ClusterResourceFailure cmdlet simulates a failure of a cluster resource.</maml:para> <maml:para>Based on the failover and failback policies, when this cmdlet runs, the Cluster service moves the clustered role, or resource group, and attempts to bring the clustered resource online. This cmdlet can be used to simulate what actions the Cluster service will take when a resource fails.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-ClusterResourceFailure</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource of which to simulate failure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource of which to simulate failure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster resource of which to simulate failure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster resource of which to simulate failure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Test-ClusterResourceFailure –Name "Cluster Disk 4" Name State Group ResourceType ---- ----- ----- ------------ Cluster Disk 4 Failed cluster12FS Physical Disk </dev:code> <dev:remarks> <maml:para>This example simulates a failure in cluster resource named Cluster Disk 4.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321080</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-ClusterIPResource</command:name> <maml:description> <maml:para>Renews or releases the DHCP lease for an IP address resource in a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>ClusterIPResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Update-ClusterIPResource cmdlet renews or releases the DHCP lease for an IP address resource in a failover cluster. This cmdlet applies only to IP address resources that use DHCP.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-ClusterIPResource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster IP address resource to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster IP address resource to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Release</maml:name> <maml:description> <maml:para>Causes the cmdlet to release the DHCP lease of the IP address resource.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Renew</maml:name> <maml:description> <maml:para>Causes the cmdlet to renew the DHCP lease of the IP address resource.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the cluster IP address resource to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cluster IP address resource to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Release</maml:name> <maml:description> <maml:para>Causes the cmdlet to release the DHCP lease of the IP address resource.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Renew</maml:name> <maml:description> <maml:para>Causes the cmdlet to renew the DHCP lease of the IP address resource.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Update-ClusterIPResource –Name "Cluster IP Address" Name State Group ResourceType ---- ----- ----- ------------ Cluster IP Address Online Cluster Group IP Address </dev:code> <dev:remarks> <maml:para>This example updates the DHCP lease for the resource called Cluster IP Address if this resource is DHCP assigned.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource | Where-Object –FilterScript {$_.ResourceType.Name -eq "IP Address"} | Update-ClusterIPResource Name State Group ResourceType ---- ----- ----- ------------ Cluster IP Address Online Cluster Group IP Address IP Address 172.2... Online cluster1-Other IP Address IP Address 172.2... Online cluster1-FS IP Address </dev:code> <dev:remarks> <maml:para>This example updates the DHCP lease for all of the clustered IP resources that are DHCP assigned.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource –Name "IP Address 172.24.11.0" | Stop-ClusterResource | Update-ClusterIPResource -Release Name State Group ResourceType ---- ----- ----- ------------ IP Address 172.2... Offline cluster1-Other IP Address </dev:code> <dev:remarks> <maml:para>This example takes the resource named IP Address 172.24.11.0 offline, and releases the DHCP lease for that resource.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321081</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Where-Object</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-ClusterNetworkNameResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-ClusterNetworkNameResource</command:name> <maml:description> <maml:para>Registers existing Network Name resources with a DNS server in a way that does not interrupt cluster availability.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>ClusterNetworkNameResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Update-ClusterNetworkNameResource cmdlet registers existing Network Name resources with a DNS server in a way that does not interrupt cluster availability.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-ClusterNetworkNameResource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the network name to be registered with the DNS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the network name resource to register with the DNS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the network name resource to register with the DNS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the network name to be registered with the DNS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringCollection</command:parameterValue> <dev:type> <maml:name>StringCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-ClusterResource "Cluster Name" | Update-ClusterNetworkNameResource Name State OwnerGroup ResourceType ---- ----- ---------- ------------ Cluster Name Online Cluster Group Network Name </dev:code> <dev:remarks> <maml:para>This example registers the Network Name resources of the local cluster with a DNS server.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321082</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ClusterResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-ClusterIPResource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-ClusterVirtualMachineConfiguration</command:name> <maml:description> <maml:para>Refreshes the configuration of a clustered virtual machine within a failover cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>ClusterVirtualMachineConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Update-ClusterVirtualMachineConfiguration cmdlet refreshes the configuration of a clustered virtual machine within a failover cluster. Use this cmdlet if a hardware device, such as a network adapter, is to be added or removed or the hardware configuration settings, such as the setting for virtual memory, are being changed for a clustered virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-ClusterVirtualMachineConfiguration</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine resource to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered virtual machine resource to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>VMId</maml:name> <maml:description> <maml:para>Specifies the virtual machine identifier (ID).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Cluster</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the clustered virtual machine resource to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the clustered virtual machine resource to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>VMId</maml:name> <maml:description> <maml:para>Specifies the virtual machine identifier (ID).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.FailoverClusters.PowerShell.ClusterResource</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Update-ClusterVirtualMachineConfiguration –Name "Virtual Machine Configuration VM1" Name State Group ResourceType ---- ----- ----- ------------ Virtual Machine ... Online Virtual Machine Virtual Machine ... </dev:code> <dev:remarks> <maml:para>This example refreshes the clustered virtual machine named Virtual Machine Configuration VM1 on the local cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Update-ClusterVirtualMachineConfiguration –Name "Virtual Machine Configuration VM2" -Cluster cluster1 Name State Group ResourceType ---- ----- ----- ------------ Virtual Machine ... Online Virtual Machine Virtual Machine </dev:code> <dev:remarks> <maml:para>This example refreshes the clustered virtual machine named Virtual Machine Configuration VM2 on the cluster named cluster1.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=321083</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ClusterVirtualMachineRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ClusterVirtualMachineRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |