Windows Cluster can be found in every enterprise. We want to have high availability of our server application which increases the scope of having clusters. We are talking about Windows clusters only, your requirement might not match if you are using third-party clusters by Veritas and others.
My requirement of getting cluster related information was different but it might suit any Windows administrator. Basically, I am DBA Engineer and I was writing script which could collect SQL Server cluster information. So it required to know if there are below resources available:
1. Network resource
2. Disk Resource
3. Nodes
PREREQUISITES
We are going to use cmdlets which are not available in Powershell as native. Yeah, you understood - we are going to import module. But I am not talking about any third party material (which I don't like). The module is provided by Microsoft itself. If you have Windows 2008 and above, you might find the module already. For Windows 2003 and previous versions, I will let you know different set of commands (I don't leave any stone unturned).
INITIAL STEPS
Step [1] Find if module is available
Please run below command to list all the modules.
get-module -listAvailable
Step [2] Import the Module
import-module failoverclusters
If you are writing any script, make sure you import the module.
ACTION
1. Find the Network resource
Here, I will just tell you the cmdlet to know what all network resource names can be seen on Windows cluster.
Get-ClusterNetwork -Cluster <cluster name>
2. Find the Disk resource
Get-ClusterResource -Cluster <Cluster name>
3. Cluster nodes info
Get-ClusterNode -Cluster <Cluster Name>
4. Find Cluster groups available
Get-ClusterGroup -Cluster <Cluster Name>
Below is the list of cmdlets which can help you manage cluster:
Add-ClusterDisk
Make 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.
Add-ClusterFileServerRole
Create a clustered file server (resource group that includes one or more disks, on which you can create shared folders for users).
Add-ClusterGenericApplicationRole
Configure high availability for an application that was not originally designed to run in a failover cluster.
Add-ClusterGenericScriptRole
Configure an application controlled by a script that runs in Windows Script Host, within a failover cluster.
Add-ClusterGenericServiceRole
Configure high availability for a service that was not originally designed to run in a failover cluster.
Add-ClusterGroup
Add an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group.
Add-ClusterNode
Add a node (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.
Add-ClusterPrintServerRole
Create a clustered print server (a resource group that includes a printer and a disk for storing print job information and printer drivers).
Add-ClusterResource
Add a resource to a clustered service or application (resource group) in a failover cluster.
Add-ClusterResourceDependency
Add a resource to the list of resources that a particular resource depends on (using AND as the connector) within a failover cluster. Existing dependencies will remain in the list.
Add-ClusterResourceType
Add a resource type to a failover cluster, and specify information such as the dynamic-link library (DLL) to use with that resource type.
Add-ClusterServerRole
Add a group containing only a client access point and storage to the failover cluster configuration.
Add-ClusterSharedVolume
Make a volume available in Cluster Shared Volumes in a failover cluster.
Add-ClusterVirtualMachineRole
Create a clustered virtual machine, that is, a virtual machine that can be failed over if necessary to a different server in the failover cluster.
Block-ClusterAccess
Prevent the specified user or users from accessing a failover cluster.
Clear-ClusterDiskReservation
Clear the persistent reservation on a disk in a failover cluster.
Clear-ClusterNode
Clear the cluster configuration from a node that was evicted from a failover cluster.
Get-Cluster
Get information about one or more failover clusters in a given domain.
Get-ClusterAccess
Get information about permissions that control access to a failover cluster.
Get-ClusterAvailableDisk
Get 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.
Get-ClusterGroup
Get information about one or more clustered services or applications (resource groups) in a failover cluster.
Get-ClusterLog
Create a log file for all nodes (or a specific node) in a failover cluster.
Get-ClusterNetwork
Get information about one or more networks in a failover cluster.
Get-ClusterNetworkInterface
Get information about one or more network adapters in a failover cluster.
Get-ClusterNode
Get information about one or more nodes (servers) in a failover cluster.
Get-ClusterOwnerNode
For a resource in a failover cluster, get information about which nodes can own the resource. For a clustered service or application (a resource group), get information about the order of preference among owner nodes.
Get-ClusterParameter
Get 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.
Get-ClusterQuorum
Get information about the quorum configuration of a failover cluster.
Get-ClusterResource
Get information about one or more resources in a failover cluster.
Get-ClusterResourceDependency
Get information about the dependencies that have been configured between clustered resources in a failover cluster.
Get-ClusterResourceDependencyReport
Generate a report that lists the dependencies between resources in a failover cluster.
Get-ClusterResourceType
Get information about one or more resource types in a failover cluster.
Get-ClusterSharedVolume
Get information about Cluster Shared Volumes in a failover cluster.
Grant-ClusterAccess
Grant access to a failover cluster, either full access or read-only access.
Move-ClusterGroup
Move a clustered service or application (a resource group) from one node to another in a failover cluster.
Move-ClusterResource
Move a clustered resource from one clustered service or application to another within a failover cluster.
Move-ClusterSharedVolume
Move a Cluster Shared Volume to ownership by a different node in a failover cluster.
Move-ClusterVirtualMachineRole
Move the ownership of a clustered virtual machine to a different node.
New-Cluster
Create a new failover cluster. Before you can create a cluster, you must connect the hardware (servers, networks, and storage), and run the validation tests.
Remove-Cluster
Destroy an existing failover cluster. The affected servers will no longer function together as a cluster.
Remove-ClusterAccess
Remove a user from the access list on the cluster.
Remove-ClusterGroup
Remove a clustered service or application (also called a resource group) from a failover cluster.
Remove-ClusterNode
Remove a node from a failover cluster. After the node is removed, it no longer functions as part of the cluster unless you add it back to the cluster.
Remove-ClusterResource
Remove a clustered resource from the failover cluster.
Remove-ClusterResourceDependency
Remove a dependency between two resources in a clustered service or application within a failover cluster.
Remove-ClusterResourceType
Remove a resource type from a failover cluster.
Remove-ClusterSharedVolume
Remove a volume from the Cluster Shared Volumes in a failover cluster, and place it in Available Storage in the cluster.
Repair-ClusterSharedVolume
Run repair tools on a Cluster Shared Volume locally on a cluster node.
Resume-ClusterNode
Resume activity on a failover cluster node after you have suspended it (that is, paused it).
Resume-ClusterResource
Turn off maintenance for a disk resource or Cluster Shared Volume within a failover cluster.
Set-ClusterLog
Set the size and level of detail for the cluster log.
Set-ClusterOwnerNode
For a resource in a failover cluster, specify which nodes can own the resource. For a clustered service or application (a resource group), specify information about the order of preference among owner nodes.
Set-ClusterParameter
Control specific properties of an object in a failover cluster, such as a resource, a group, or a network.
Set-ClusterQuorum
Configure quorum options for a failover cluster.
Set-ClusterResourceDependency
Specify the resources that a particular resource depends on within a failover cluster. Existing dependencies will be overwritten by the dependencies that you specify.
Start-Cluster
Start the Cluster service on all nodes of the cluster on which it is not yet started.
Start-ClusterGroup
Bring one or more clustered services and applications (also known as resource groups) online on a failover cluster.
Start-ClusterNode
Start the Cluster service on a node in a failover cluster.
Start-ClusterResource
Bring a resource online in a failover cluster.
Stop-Cluster
Stop the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster.
Stop-ClusterGroup
Take one or more clustered services and applications (also known as resource groups) offline on a failover cluster.
Stop-ClusterNode
Stop the Cluster service on a node in a failover cluster.
Stop-ClusterResource
Take a resource offline in a failover cluster.
Suspend-ClusterNode
Suspend activity on a failover cluster node, that is, pause the node.
Suspend-ClusterResource
Turn on maintenance for a disk resource or Cluster Shared Volume so that you can run a disk maintenance tool without triggering failover.
Test-Cluster
Run validation tests for failover cluster hardware and settings. Tests can be run both before and after a cluster is set up.
Test-ClusterResourceFailure
Simulate a failure of a cluster resource.
Update-ClusterIPResource
Renew or release the DHCP lease for an IP address resource in a failover cluster.
Update-ClusterVirtualMachineConfiguration
Refresh the configuration of a clustered virtual machine within a failover cluster
Cluster.exe <Cluster Name> /prop
Get-Cluster <Cluster Name> | fl *
Cluster.exe <Cluster Name> /priv
Get-Cluster <Cluster Name> | Get-ClusterParameter
Cluster.exe <Cluster Name> group
Get-ClusterGroup -Cluster <Cluster Name>
Cluster.exe <cluster Name> node
Get-ClusterNode -Cluster <Cluster Name>
Cluster.exe <cluster name> res
Get-ClusterResource -Cluster <Cluster name>
Cluster.exe <Cluster name> net
Get-ClusterNetwork -Cluster <cluster name>
Cluster.exe <cluster name> netint
Get-ClusterNetworkInterface -Cluster <cluster name>
Cluster.exe <cluster name> group /move:<Node name>
Move-ClusterGroup -Name <group name> -Node <Node name> -Cluster <cluster name>
Cluster.exe log
Get-ClusterLog
Cluster.exe <cluster name> /create …
New-Cluster
Cluster.exe <cluster name> group /add
Add-ClusterGroup
Cluster.exe <cluster name> group <group name> /on
Start-ClusterGroup -Name <group name> -Cluster <cluster name>
CONCLUSION
As you can see the module failoverclusters gives you more and more options to manage cluster. Sorry, I could not add any script for this article, but you may ask me in case you want, I will reply once I get time.
My requirement of getting cluster related information was different but it might suit any Windows administrator. Basically, I am DBA Engineer and I was writing script which could collect SQL Server cluster information. So it required to know if there are below resources available:
1. Network resource
2. Disk Resource
3. Nodes
PREREQUISITES
We are going to use cmdlets which are not available in Powershell as native. Yeah, you understood - we are going to import module. But I am not talking about any third party material (which I don't like). The module is provided by Microsoft itself. If you have Windows 2008 and above, you might find the module already. For Windows 2003 and previous versions, I will let you know different set of commands (I don't leave any stone unturned).
INITIAL STEPS
Step [1] Find if module is available
Please run below command to list all the modules.
get-module -listAvailable
Step [2] Import the Module
import-module failoverclusters
If you are writing any script, make sure you import the module.
ACTION
1. Find the Network resource
Here, I will just tell you the cmdlet to know what all network resource names can be seen on Windows cluster.
Get-ClusterNetwork -Cluster <cluster name>
2. Find the Disk resource
Get-ClusterResource -Cluster <Cluster name>
3. Cluster nodes info
Get-ClusterNode -Cluster <Cluster Name>
4. Find Cluster groups available
Get-ClusterGroup -Cluster <Cluster Name>
Below is the list of cmdlets which can help you manage cluster:
Add-ClusterDisk
Make 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.
Add-ClusterFileServerRole
Create a clustered file server (resource group that includes one or more disks, on which you can create shared folders for users).
Add-ClusterGenericApplicationRole
Configure high availability for an application that was not originally designed to run in a failover cluster.
Add-ClusterGenericScriptRole
Configure an application controlled by a script that runs in Windows Script Host, within a failover cluster.
Add-ClusterGenericServiceRole
Configure high availability for a service that was not originally designed to run in a failover cluster.
Add-ClusterGroup
Add an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group.
Add-ClusterNode
Add a node (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.
Add-ClusterPrintServerRole
Create a clustered print server (a resource group that includes a printer and a disk for storing print job information and printer drivers).
Add-ClusterResource
Add a resource to a clustered service or application (resource group) in a failover cluster.
Add-ClusterResourceDependency
Add a resource to the list of resources that a particular resource depends on (using AND as the connector) within a failover cluster. Existing dependencies will remain in the list.
Add-ClusterResourceType
Add a resource type to a failover cluster, and specify information such as the dynamic-link library (DLL) to use with that resource type.
Add-ClusterServerRole
Add a group containing only a client access point and storage to the failover cluster configuration.
Add-ClusterSharedVolume
Make a volume available in Cluster Shared Volumes in a failover cluster.
Add-ClusterVirtualMachineRole
Create a clustered virtual machine, that is, a virtual machine that can be failed over if necessary to a different server in the failover cluster.
Block-ClusterAccess
Prevent the specified user or users from accessing a failover cluster.
Clear-ClusterDiskReservation
Clear the persistent reservation on a disk in a failover cluster.
Clear-ClusterNode
Clear the cluster configuration from a node that was evicted from a failover cluster.
Get-Cluster
Get information about one or more failover clusters in a given domain.
Get-ClusterAccess
Get information about permissions that control access to a failover cluster.
Get-ClusterAvailableDisk
Get 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.
Get-ClusterGroup
Get information about one or more clustered services or applications (resource groups) in a failover cluster.
Get-ClusterLog
Create a log file for all nodes (or a specific node) in a failover cluster.
Get-ClusterNetwork
Get information about one or more networks in a failover cluster.
Get-ClusterNetworkInterface
Get information about one or more network adapters in a failover cluster.
Get-ClusterNode
Get information about one or more nodes (servers) in a failover cluster.
Get-ClusterOwnerNode
For a resource in a failover cluster, get information about which nodes can own the resource. For a clustered service or application (a resource group), get information about the order of preference among owner nodes.
Get-ClusterParameter
Get 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.
Get-ClusterQuorum
Get information about the quorum configuration of a failover cluster.
Get-ClusterResource
Get information about one or more resources in a failover cluster.
Get-ClusterResourceDependency
Get information about the dependencies that have been configured between clustered resources in a failover cluster.
Get-ClusterResourceDependencyReport
Generate a report that lists the dependencies between resources in a failover cluster.
Get-ClusterResourceType
Get information about one or more resource types in a failover cluster.
Get-ClusterSharedVolume
Get information about Cluster Shared Volumes in a failover cluster.
Grant-ClusterAccess
Grant access to a failover cluster, either full access or read-only access.
Move-ClusterGroup
Move a clustered service or application (a resource group) from one node to another in a failover cluster.
Move-ClusterResource
Move a clustered resource from one clustered service or application to another within a failover cluster.
Move-ClusterSharedVolume
Move a Cluster Shared Volume to ownership by a different node in a failover cluster.
Move-ClusterVirtualMachineRole
Move the ownership of a clustered virtual machine to a different node.
New-Cluster
Create a new failover cluster. Before you can create a cluster, you must connect the hardware (servers, networks, and storage), and run the validation tests.
Remove-Cluster
Destroy an existing failover cluster. The affected servers will no longer function together as a cluster.
Remove-ClusterAccess
Remove a user from the access list on the cluster.
Remove-ClusterGroup
Remove a clustered service or application (also called a resource group) from a failover cluster.
Remove-ClusterNode
Remove a node from a failover cluster. After the node is removed, it no longer functions as part of the cluster unless you add it back to the cluster.
Remove-ClusterResource
Remove a clustered resource from the failover cluster.
Remove-ClusterResourceDependency
Remove a dependency between two resources in a clustered service or application within a failover cluster.
Remove-ClusterResourceType
Remove a resource type from a failover cluster.
Remove-ClusterSharedVolume
Remove a volume from the Cluster Shared Volumes in a failover cluster, and place it in Available Storage in the cluster.
Repair-ClusterSharedVolume
Run repair tools on a Cluster Shared Volume locally on a cluster node.
Resume-ClusterNode
Resume activity on a failover cluster node after you have suspended it (that is, paused it).
Resume-ClusterResource
Turn off maintenance for a disk resource or Cluster Shared Volume within a failover cluster.
Set-ClusterLog
Set the size and level of detail for the cluster log.
Set-ClusterOwnerNode
For a resource in a failover cluster, specify which nodes can own the resource. For a clustered service or application (a resource group), specify information about the order of preference among owner nodes.
Set-ClusterParameter
Control specific properties of an object in a failover cluster, such as a resource, a group, or a network.
Set-ClusterQuorum
Configure quorum options for a failover cluster.
Set-ClusterResourceDependency
Specify the resources that a particular resource depends on within a failover cluster. Existing dependencies will be overwritten by the dependencies that you specify.
Start-Cluster
Start the Cluster service on all nodes of the cluster on which it is not yet started.
Start-ClusterGroup
Bring one or more clustered services and applications (also known as resource groups) online on a failover cluster.
Start-ClusterNode
Start the Cluster service on a node in a failover cluster.
Start-ClusterResource
Bring a resource online in a failover cluster.
Stop-Cluster
Stop the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster.
Stop-ClusterGroup
Take one or more clustered services and applications (also known as resource groups) offline on a failover cluster.
Stop-ClusterNode
Stop the Cluster service on a node in a failover cluster.
Stop-ClusterResource
Take a resource offline in a failover cluster.
Suspend-ClusterNode
Suspend activity on a failover cluster node, that is, pause the node.
Suspend-ClusterResource
Turn on maintenance for a disk resource or Cluster Shared Volume so that you can run a disk maintenance tool without triggering failover.
Test-Cluster
Run validation tests for failover cluster hardware and settings. Tests can be run both before and after a cluster is set up.
Test-ClusterResourceFailure
Simulate a failure of a cluster resource.
Update-ClusterIPResource
Renew or release the DHCP lease for an IP address resource in a failover cluster.
Update-ClusterVirtualMachineConfiguration
Refresh the configuration of a clustered virtual machine within a failover cluster
Equivalent commands for pervious version of Windwos 2003:
Cluster.exe <Cluster Name> /prop
Get-Cluster <Cluster Name> | fl *
Cluster.exe <Cluster Name> /priv
Get-Cluster <Cluster Name> | Get-ClusterParameter
Cluster.exe <Cluster Name> group
Get-ClusterGroup -Cluster <Cluster Name>
Cluster.exe <cluster Name> node
Get-ClusterNode -Cluster <Cluster Name>
Cluster.exe <cluster name> res
Get-ClusterResource -Cluster <Cluster name>
Cluster.exe <Cluster name> net
Get-ClusterNetwork -Cluster <cluster name>
Cluster.exe <cluster name> netint
Get-ClusterNetworkInterface -Cluster <cluster name>
Cluster.exe <cluster name> group /move:<Node name>
Move-ClusterGroup -Name <group name> -Node <Node name> -Cluster <cluster name>
Cluster.exe log
Get-ClusterLog
Cluster.exe <cluster name> /create …
New-Cluster
Cluster.exe <cluster name> group /add
Add-ClusterGroup
Cluster.exe <cluster name> group <group name> /on
Start-ClusterGroup -Name <group name> -Cluster <cluster name>
CONCLUSION
As you can see the module failoverclusters gives you more and more options to manage cluster. Sorry, I could not add any script for this article, but you may ask me in case you want, I will reply once I get time.
If you could post an example script of how to remove a FRMS dependency is a cluster resource group that would be appreciated. We are trying to remove some of the older LUns and the tech forgot to remove a reporting dependency.
ReplyDeleteThis comment has been removed by a blog administrator.
ReplyDeleteI have been facing issue in finding physical disk associated to cluster disk in case of GPT partition. There is no issue with MBR where signature field exists in both
ReplyDeleteWin32_DiskDrive and MSCluster_disk. however signature field is blank in case of GPT partition.
I need something like
+===================================================+
|Drive Number Cluster Disk Owner Node |
+===================================================+
|PHYSICALDRIVE16 Cluster Disk 9 |
=====================================================
I am unable to import the module failoverclusters.. How to trouble shoot it. Powershell version is 3
ReplyDeleteImport-failoverclusters module cannot be imported on Windows server 2008
ReplyDeletehow to get cluster resource there status and current owner..plz help
ReplyDelete$ClusterResource = Get-ClusterResource -Name "Name of your resource"
Delete$ClusterResource.State #Status
$ClusterResource.OwnerGroup #Current Owner group.
Hi i couldn't get import-module failoverclusters in windows server 2008 (not r2). upgraded the Powershell to 3.0. Actually i Need to change cluster ip address after srm failover.
ReplyDeleteI want to take a resource offline and bring it back online. This is simple enough and works fine when I run the script by hand, but I can't get it to recognize the commands when I try to do the same in a background batch job. I have tried adding "import-module failoverclusters" which I don't need when running the script live and it still doesn't recognize the commands. Any suggestions?
ReplyDeleteCan somebody please help with a powershell script to fetch cluster information using a servers list in a text file , which includes preferred node information, roles and services running on which node and disk health details
ReplyDeleteNeed something to find all the nodes of cluster in multiple clustered servers. I don't know the cluster names.
ReplyDeletehow to get the cluster node details(Manufacturer, Model, Name, Serial#)
ReplyDeleteVery significant Information for us, I have think the representation of this Information is actually superb one. This is my first visit to your site. Microsoft Dynamics 365 Business Central: Analítica, informes e integración con Power BI
ReplyDelete