21.16.3 get_job_status

Description

This Tcl command exports status of current open job. The job status contains a number of devices left for each HSM ticket. If job status file is not specified, the information is printed in the log window.

get_job_status [-job_status_file "job status file"] [-archive "TRUE | FALSE"]

Arguments

ParameterTypeDescription
job_status_filestringPath to the output FlashPro Express job status container. The job status file can be sent to the Job Manager application and Certificates of Conformance (if available) validated using the U-HSM. This parameter is optional.
archivebooleanMoves the HSM ticket log files from the HSM ticket database to the HSM ticket archive. The archive folder is specified during HSM installation and setup. This parameter is optional.
Note: If no job_status_file is specified, the archive option prints the Certificates of Conformance in the log window without exporting them.
Return TypeDescription
IntegerReturns a number of devices.

Error Codes

Error CodeDescription
NoneFpeng error: Chain manager not set
NoneParameter 'param_name' is not defined. Valid command formatting is 'get_job_status [-job_status_file "job status file"] \ [-archive "TRUE | FALSE"]'.

Supported Families

PolarFire®
SmartFusion® 2
RTG4
IGLOO® 2
PolarFire SoC

Example

The following example displays the status of current open job status:

puts [get_job_status]

See Also

  • create_job_project