PostStep element

Article
03/28/2018

Defines the PostStep stage of a custom diagnostic test. The PostStep stage processes the output from all of the nodes on which the test ran and prepares the results for display.

Usage

<PostStep Element
  Command = "character_string"
  ResultXml = "boolean">
  child elements
</PostStep Element>

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 PostStep stage of the test. You can specify any command or application that you can run from a command prompt, if it performs the tasks that are described in Diagnostic Test Stages. 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 diagnostic service reads the PostStepResult.xml file to get information about the results of the test. True indicates that the diagnostic service reads the PostStepResult.xml file to get information about the results of the test. False indicates that the diagnostic service does not read the PostStepResult.xml file to get information about the results of the test.

Command

character_string

Yes

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

You can specify any command or application that you can run from a command prompt, if it performs the tasks that are described in Diagnostic Test Stages. 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 diagnostic service reads the PostStepResult.xml file to get information about the results of the test. True indicates that the diagnostic service reads the PostStepResult.xml file to get information about the results of the test. False indicates that the diagnostic service does not read the PostStepResult.xml file to get information about the results of the test.

Child elements

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

EnvironmentVariables

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

Parameters

Defines a set of one or more parameters for the PostStep 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 PostStep stage of a diagnostic test runs only on the head node.

If you include the AutoGenerateResult element in the definition of a custom diagnostic test, the test report is automatically generated and you do not need to implement a PostStep stage for the test. You can include the AutoGenerateResult element or the PostStep element in the XML file that defines a custom diagnostic test, but you cannot include both elements.

Element information

Schema file	DiagnosticTests.xsd
Can be empty	Yes