RunStep element

Article
03/28/2018

Defines the RunStep stage of a custom diagnostic test. The RunStep stage runs the actual diagnostic test.

Usage

<RunStep
  Command = "character_string"
  ResultXml = "boolean">
  child elements
</RunStep>

Attributes

Attribute Type Required Description

Attribute	Type	Required	Description
Command	character_string	Yes	Specifies the command line for the command or application that you want to run for the RunStep stage of the test. You can specify any command or application that you can run from a command prompt. Possible commands include command-line commands, command files or batch files, instances of Windows PowerShell, and compiled console applications. If the command that you want to specify includes quotation marks (such as a command that includes a path with spaces) or other special characters in XML, use character entities to specify the characters, for example, `"`. For more information about character entities, see Character and Entity References (https://go.microsoft.com/fwlink/p/?linkid=165386). The maximum length of the command line is 255 characters.
ResultXml	boolean	No	Indicates whether the result of the test for the node depends on StepResult XML content that the RunStep command sends to standard output, for tests that do not specify a PostStep or AutoGenerateResult element. True indicates that the RunStep command on each node sends StepResult XML to standard output and that the result of the test for each node depends on that output. False indicates that the result of the test for the node depends on the result of the task for the node in the clusrun job for the RunStep stage.

Command

character_string

Yes

Specifies the command line for the command or application that you want to run for the RunStep stage of the test.

You can specify any command or application that you can run from a command prompt. Possible commands include command-line commands, command files or batch files, instances of Windows PowerShell, and compiled console applications.

If the command that you want to specify includes quotation marks (such as a command that includes a path with spaces) or other special characters in XML, use character entities to specify the characters, for example, ". For more information about character entities, see Character and Entity References (https://go.microsoft.com/fwlink/p/?linkid=165386).

The maximum length of the command line is 255 characters.

ResultXml

boolean

Indicates whether the result of the test for the node depends on StepResult XML content that the RunStep command sends to standard output, for tests that do not specify a PostStep or AutoGenerateResult element.

True indicates that the RunStep command on each node sends StepResult XML to standard output and that the result of the test for each node depends on that output. False indicates that the result of the test for the node depends on the result of the task for the node in the clusrun job for the RunStep stage.

Child elements

Element	Description
EnvironmentVariables	Represents a set of one or more environment variables that you want to set for the RunStep stage of the diagnostic test.
Parameters	Defines a set of one or more parameters for the RunStep stage in the diagnostic test.

EnvironmentVariables

Represents a set of one or more environment variables that you want to set for the RunStep stage of the diagnostic test.

Parameters

Defines a set of one or more parameters for the RunStep stage in the diagnostic test.

Child element sequence

Parameters?EnvironmentVariables?

Parent elements

Element	Description
DiagnosticTest	Defines a custom diagnostic test, including the metadata, parameters, environment variables, and commands for the test.

DiagnosticTest

Defines a custom diagnostic test, including the metadata, parameters, environment variables, and commands for the test.

Remarks

The RunStep stage of a diagnostic test runs once on each of the nodes in the list of nodes in the output of the PreStep stage. A RunStep element is required in the test definition of a test that runs a command, and the RunStep element is not allowed in the test definition of a test that runs a job.

Element information

Schema file	DiagnosticTests.xsd
Can be empty	Yes