Find-SCCluster
Find-SCCluster
Finds the specified failover cluster in a VMM environment.
構文
Parameter Set: UserCredentials
Find-SCCluster [-ComputerName] <String> -Credential <VMMCredential> [-EnumerateFileServers <Boolean]> ] [-JobVariable <String> ] [-NonTrustedDomainHost] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ServerCredentials
Find-SCCluster -LibraryServer <LibraryServer> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: XenServerHost
Find-SCCluster [-ComputerName] <String> -Credential <VMMCredential> -XenServerHost [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-TCPPort <UInt32]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
詳細説明
The Find-SCCluster cmdlet queries Virtual Machine Manager (VMM) for the specified failover cluster or one of its nodes. If the cluster is found, VMM returns an object that contains more information about the failover cluster. Information returned by Find-SCCluster includes cluster name, nodes of the cluster, and highly available file servers hosted by the cluster.
パラメーター
-ComputerName<String>
Specifies the name of a computer that VMM can uniquely identify on your network. Valid formats are:
-- FQDN
-- IPv4 or IPv6 address
-- NetBIOS name
NOTE: See the examples for a specific cmdlet to determine how that cmdlet specifies the computer name.
エイリアス |
none |
必須? |
true |
位置は? |
1 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Credential<VMMCredential>
Specifies a credential object or, for some cmdlets, a Run As account object that contains the user name and password of an account that has permission to perform this action. Or, in the case of Restart-SCJob, has permission to complete a restarted task.
For more information about the PSCredential object, type: Get-Help Get-Credential
.
For more information about Run As accounts, type: Get-Help New-SCRunAsAccount
.
エイリアス |
none |
必須? |
true |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-EnumerateFileServers<Boolean]>
Indicates whether the file servers are listed.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-LibraryServer<LibraryServer>
Specifies a VMM library server object.
エイリアス |
none |
必須? |
true |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-NonTrustedDomainHost
Indicates that the host to be added to VMM belongs to a non-trusted domain.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-TCPPort<UInt32]>
Specifies a numeric value that represents a TCP port.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
True (ByValue) |
ワイルドカード文字を許可する |
false |
-XenServerHost
Indicates that the specified host is a Citrix XenServer host.
エイリアス |
none |
必須? |
true |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
- Cluster
例
Example 1: Find all nodes of a failover cluster from the cluster name
The first command gets the Run As account object named RunAsAccount01, and then stores the object in the $Credential variable.
The second command queries VMM for the failover cluster named VMHostCluster01, and then stores the cluster object in $Cluster, using $Credential to provide the Run As account to Find-SCCluster. The ComputerName parameter treats the name of the cluster as if it were the name of a computer.
The last command displays the FQDNs of the cluster nodes to the user.
PS C:\> $Credential = Get-SCRunAsAccount -Name "RunAsAccount01"
PS C:\> $Cluster = Find-SCCluster -ComputerName "VMHostCluster01.Contoso.com" -Credential $Credential
PS C:\> $Cluster.ClusterNodes
Example 2: Find all nodes of a failover cluster from one of the node names
The first command gets the Run As account object named RunAsAccount01, and then stores the object in the $Credential variable.
The second command queries VMM for a failover cluster node named VMHostNode02 and stores the returned cluster object in $Cluster.
The third command displays the FQDN of the cluster to the user.
The last command displays the FQDN of each node in the cluster to the user.
PS C:\> $Credential = Get-SCRunAsAccount -Name "RunAsAccount01"
PS C:\> $Cluster = Find-SCCluster -ComputerName "VMHostNode02.Contoso.com" -Credential $Credential
PS C:\> $Cluster.Name
PS C:\> $Cluster.ClusterNodes
Example Example 3: Find, by using the cluster name, all highly available file servers hosted by that failover cluster.
The first command gets the RunAs account object RunAsAccount01, and then stores the object in the $Credential variable.
The second command queries VMM for the failover cluster named VMHostCluster03, and then stores the cluster object in $Cluster.
The third command displays the FQDNs of all highly available file servers hosted by the failover cluster stored in $Cluster. This example assumes that the failover cluster is hosting at least one highly available file server.
PS C:\> $Credential = Get-SCRunAsAccount -Name "RunAsAccount01"
PS C:\> $Cluster = Find-SCCluster -ComputerName "VMHostCluster03.Contoso.com" -Credential $Credential
PS C:\> $Cluster.HAFileServers