Assessment Platform Command-Line Syntax

The Assessment Platform is available for use from the command line by using AXE.exe, a command-line tool that you can use to automate jobs from a script and minimize resource usage. In addition, command-line options provide access to parameters that are not available through the Windows Assessment Console.

AXE.exe has limitations: You cannot use it to run a preconfigured job or one of the single assessments provided by the Windows Assessment Toolkit. You also cannot create or modify a job by using AXE.exe; for creating or modifying a job, you must use the Windows Assessment Console.

AXE.exe is installed with the Windows Assessment Toolkit, and by default it is installed to the following folder:

%ProgramFiles(x86)%\Windows Kits\10\Assessment and Deployment Kit\Windows Assessment Toolkit<em>architecture</p>

where architecture is one of the following: amd64, arm, arm64, x86.

Command-Line Options

AXE.exe uses the following syntax:

axe job_file /Timeout seconds] [/NoPublish] [/PublishPath folder_path] [/RemoveRestart] [/DisplayLog ETL_file] [/NoWarnings] [/JobParameter parameter=value] [/Pause]

axe /Analyze results_file [/Job job_file] [/Assessment assessment_file]

These options are described in the following table. The names of these options are not case-sensitive.


Option

Description

Help or /?

Displays information about available AXE.exe command-line options.

job_file

Specifies the job (.jobx) file that you want to run, and job_file can specify a relative path. If the job file is in the directory from which you're running AXE.exe, no path is required.

By default, when you create a job in the Windows Assessment Console, it's saved in to %USERPROFILE%\Documents\Windows Assessment Console\Jobs\.

Note   This option is required if no other parameter that performs an action is specified.

Example:

axe C:\Assessments\MyJobs\Job1.jobx

/Job job_file

Specifies the path and file name of the job file, job_file, to use in locating the assessments to reanalyze within the results file.

/Analyze results_file

Reanalyzes the results from a job (.jobx) file specified by results_file. This option requires a job from a package or assessment manifest directly to locate the assessments to reanalyze.

/Assessment assessment_file

Specifies the path and file name of an assessment manifest, assessment_file, to reanalyze in the results file specified.

/Timeout seconds

Specifies the amount of time in seconds that the job will wait for another job to finish before it exits with an error. When seconds is zero, the default, the job will exit immediately without running if another job is already running.

Example:

axe C:\Assessments\myJobs\Job1.jobx /Timeout 30

/NoPublish

Specifies to not publish the results file to the location that's specified in the job file. When you use this option, the results are saved to the default location, %LOCALAPPDATA%\Microsoft\Axe\Results\.

Example:

axe C:\Assessments\myJobs\Job1.jobx /NoPublish

/PublishToSource

Specifies that AXE.exe update the original results folder when running /Analyze. Using /PublishToSource is optional, and it is ignored when running a job.

/PublishToSource may be combined with the publish path, but the publish path will only be used if AXE.exe cannot publish to the original results folder.

/PublishPath folder_path

Specifies a location to publish the results file to. The path specified by folder_path overrides the publication path, ResultsPublishPath, that is specified in the job file. This option is ignored if it's combined with /NoPublish.

Example:

axe C:\Assessments\myJobs\Job1.jobx /PublishPath C:\Assessments\myResults

/DisplayLog ETL_file

Displays the content of an Event Trace Log (ETL) file specified by ETL_file, which can contain wildcard characters in the path and file name. AXE.exe writes an ETL file when running a job, and it displays the path in the console window.

The default location of the log file is %LOCALAPPDATA%\Microsoft\Axe\Logs\GUID\, where GUID is a GUID that is generated randomly for each new job. The job results file in the SessionLogFiles node also contains the full location. This node specifies all of the log files.

Note   All of the ETL files are automatically converted into a single AxeLog.txt file that is saved in the results directory. You can open this file by using Notepad.

Example:

axe /DisplayLog %LOCALAPPDATA%\Microsoft\Axe\Logs\E5A6CB43-C1CE-4FC1-8170-13B002E250B36\AxeLog-000.etl

/RemoveRestart

Specifies that any existing, pending job-restart task should be removed.

Note   The /JobFile option isn't needed when you use this option.

When you run a job, the assessment creates a task to restart the job if there's a system failure, like a loss of power. When you use this option, the task is removed from the Task Scheduler. If no job-restart task is pending, the assessment will return an error to inform you that the task doesn't exist.

Example:

axe /RemoveRestart

/NoWarnings

Suppresses warning messages. This is an optional parameter.

Example:

axe C:\Assessments\myJobs\Job1.jobx /NoWarnings

/Pause

Pauses AXE.exe after the job finishes. You can then see any errors or other information in the console before AXE.exe exits and the console closes. Exiting continues when you press a key.

Example:

axe C:\Assessments\myJobs\Job1.jobx /Pause

/JobParameter parameter=value

Specifies a value to override a job parameter that may exist in the job manifest. You can use /JobParameter up to 100 times to specify multiple job parameters. If duplicate parameter names appear, the assessment uses the last value supplied for that name. Using /JobParameter is optional.

The /PublishPath option takes precedence over setting the ResultsPublishPath job parameter with this option.

Example:

axe C:\Assessments\myJobs\Job1.jobx /JobParameter iterations=1

Windows Assessment Console Overview