Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Get-ClusterParameter
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. 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.
Syntax
Get-ClusterParameter [-InputObject <psobject>] [[-Name] <StringCollection>] [-Cluster <string>] [<CommonParameters>]
InputObject
Name
Cluster
Detailed Description
The type of detailed information you can obtain with this cmdlet depends on the cmdlet you combine it with. For example:
If you use this cmdlet with Get-ClusterResource for a disk resource, 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 Get-ClusterResource for a Network Name resource, you can obtain DNS-related information about the resource.
If you use this cmdlet with Get-ClusterResource for an IP Address resource, you can obtain DHCP-related information about the IP Address resource.
If you use this cmdlet with Get-ClusterResource for resources used by virtual machines, you can obtain details about the settings for the virtual machines.
Parameters
Cluster
Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
InputObject
Specifies the cluster object to get more information for.
Default Value: **
Data Type: psobject
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Name
Specifies the name of the cluster parameter to get.
Default Value: **
Data Type: StringCollection
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Input Type
Microsoft.FailoverClusters.PowerShell.Cluster, Microsoft.FailoverClusters.PowerShell.ClusterGroup, Microsoft.FailoverClusters.PowerShell.ClusterResource, Microsoft.FailoverClusters.PowerShell.ClusterResourceType, Microsoft.FailoverClusters.PowerShell.ClusterNetwork, Microsoft.FailoverClusters.PowerShell.ClusterNetworkInterface, Microsoft.FailoverClusters.PowerShell.ClusterNode, Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume
Return Type
Microsoft.FailoverClusters.PowerShell.ClusterParameter
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Get-ClusterResource 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
Description
-----------
This command gets the parameters (detailed information) for the cluster resource cluster1FS on the local cluster. Parameters vary according to the type of resource being viewed.
-------------------------- EXAMPLE 2 --------------------------
Command Prompt: C:\PS>
Get-ClusterResource cluster1FS | Get-ClusterParameter HostRecordTTL
Object Name Value Type
------ ---- ----- ----
cluster1FS HostRecordTTL 1200 UInt32
Description
-----------
This command displays the HostRecordTTL parameter for the cluster resource cluster1FS on the local cluster, if that parameter is applicable to cluster1FS.