Invoke-HpcTest
Invoke-HpcTest
Runs the specified diagnostic tests on one or more specified nodes.
Syntax
Parameter Set: TestNameNodeName
Invoke-HpcTest [-Alias] <String> [[-Company] <String> ] -NodeName <String[]> [-Parameters <Hashtable> ] [-RunTestAs <PSCredential> ] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: TestNameGroupName
Invoke-HpcTest [-Alias] <String> [[-Company] <String> ] -GroupName <String> [-Parameters <Hashtable> ] [-RunTestAs <PSCredential> ] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: TestNameNodeObj
Invoke-HpcTest [-Alias] <String> [[-Company] <String> ] -Node <HpcNode[]> [-Parameters <Hashtable> ] [-RunTestAs <PSCredential> ] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: TestObjGroupName
Invoke-HpcTest -GroupName <String> -Test <HpcTestCase> [-Parameters <Hashtable> ] [-RunTestAs <PSCredential> ] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: TestObjNodeName
Invoke-HpcTest -NodeName <String[]> -Test <HpcTestCase> [-Parameters <Hashtable> ] [-RunTestAs <PSCredential> ] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: TestObjNodeObj
Invoke-HpcTest -Node <HpcNode[]> -Test <HpcTestCase> [-Parameters <Hashtable> ] [-RunTestAs <PSCredential> ] [-Scheduler <String> ] [ <CommonParameters>]
Detailed Description
Runs the specified diagnostic tests on one or more specified nodes. You can specify the diagnostic test by using the alias or by specifying the HpcTestCase object for the test. You can specify the nodes by using the names or by specifying the HpcNode objects for the nodes, or you can use the name of a node group that contains the nodes.
Parameters
-Alias<String>
Specifies the alias for the diagnostic test that you want to run. Use the Get-HpcTest cmdlet to view the diagnostic tests that are available on the HPC cluster. You cannot specify both the Alias and Test parameters.
This parameter was introduced in HPC Pack 2008 R2. It is not available in previous versions. It replaced the Name parameter.
Aliases |
Name |
Required? |
true |
Position? |
1 |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Company<String>
Specifies the company that created the diagnostic test that you want to run. If you specify the Company parameter, you must also specify the Alias parameter. Specify the company if your HPC cluster includes two diagnostic tests with the same alias from different companies. You cannot specify both the Company and Test parameters.
This parameter was introduced in HPC Pack 2008 R2. It is not available in previous versions. It replaced the Name parameter.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-GroupName<String>
Specifies the name of the node group that contains the nodes on which you want to run the diagnostic tests. You cannot specify both the GroupName parameter and either the Node or the NodeName parameter.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Node<HpcNode[]>
Specifies a list of one or more HpcNode objects for the nodes on which you want to run the diagnostic tests. Use the Get-HpcNode cmdlet to get the HpcNode objects for the nodes. You cannot specify both the Node parameter and either the GroupName or the NodeName parameter.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-NodeName<String[]>
Specifies a list of one or more names for the nodes on which you want to run the diagnostic tests. Use the Get-HpcNode cmdlet to view the names of the nodes in the HPC cluster. You cannot specify both the NodeName parameter and either the GroupName or the Name parameter. This parameter is a filter parameter, so you do not receive an error for specifying a node the does not exist in the HPC cluster as long as you specify at least one node that does exist.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Parameters<Hashtable>
Specifies the values to use for the parameters of the diagnostic test. When you specify the hash table for the parameters and values, use the switch name for the parameter as the key name. For example, the ping test has parameters with the switch names of Network and count, so you can specify the hash table as @{ Network="Private" ; count=5 } if you want to use the Private network and a ping count of 5. Use the Get-HpcTestDetail cmdlet, or contact the company that created the test to determine the parameters available for the diagnostic test and their switch names.
This parameter was introduced in HPC Pack 2008 R2. It is not available in previous versions.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunTestAs<PSCredential>
Specifies the credentials under which you want the commands for the diagnostic test to run. Use the Get-Credential cmdlet to create a PSCredential object. If you specify a user name for this parameter, the cmdlet displays a dialog box that prompts you to provide a password for the user.
This parameter was introduced in HPC Pack 2008 R2. It is not available in previous versions. It replaced the Name parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Scheduler<String>
Specifies the host name or IP address of the head node for the cluster that includes the diagnostic tests and nodes. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:
Set-Content Env:CCP_SCHEDULER <head_node_name>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
%CCP_SCHEDULER% |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Test<HpcTestCase>
Specifies an HpcTestCase object for the diagnostic test that you want to run. Use the Get-HpcTest cmdlet to get the HpcTestCase object for the diagnostic test. You cannot specify both the Test and either Alias or Company parameters.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- An HpcTestCase object, or one or more HpcNode objects
Outputs
The output type is the type of the objects that the cmdlet emits.
- An HpcTestResult object
Notes
To cancel a diagnostic test run, use the Stop-HpcTestResult cmdlet.
You must be a cluster administrator to run this cmdlet successfully.
Examples
EXAMPLE 1
Runs the Ping Test on the node named ComputeNode1.
PS C:\>Invoke-HpcTest -Alias ping -NodeName ComputeNode1
EXAMPLE 2
Runs the DNS Test on all of the nodes that belong to the node group named MyNodeGroup.
PS C:\>Invoke-HpcTest -Alias dnstest -GroupName MyNodeGroup
EXAMPLE 3
Gets the HpcNode object for the node named MyComputeNode, then runs the Domain Connectivity Test on that node by redirecting that HpcNode object to the Invoke-HpcTest cmdlet.
PS C:\>Get-HpcNode -Name MyComputeNode | Invoke-HpcTest -Alias ad
EXAMPLE 4
Runs the Ping Test with the Network parameter set to Private and the ping count parameter set to 5 on ComputeNode1, and uses the credentials of the user with the user name of CONTOSO\someone. A dialog box appears when you run the cmdlet to prompt you for the password for the CONTOSO\someone account.
PS C:\>Invoke-HpcTest -Alias ping -Parameters @{ Network="Private" ; count=5 } -RunTestAs CONTOSO\someone -NodeName ComputeNode1
EXAMPLE 5
Gets the HpcTestCase object for the Domain Connectivity Test, then runs that diagnostic test on the node named ComputeNode2 by redirecting that HpcTestCase object to the Invoke-HpcTest cmdlet.
PS C:\>Get-HpcTest -Alias ad | Invoke-HpcTest -NodeName ComputeNode2