21.16.2 complete_prog_job

Description

This Tcl command completes the current open job and generates a Job Status container including cryptographically signed Job Ticket end certifiers and Certificates of Conformance (if enabled) of the programmed devices. It archives ticket data from the HSM database. The resultant Job Status container can be imported into Job Manager and validated using U-HSM. If the job status file is not specified, the information is printed in the log window, and no Job Status container is created for subsequent verification. The HSM Job can only be completed, if the number of devices in each HSM ticket has been exhausted. If devices remain, the job can only be terminated by using the "-terminate" option.

Note: This command fails, if there are devices left in any HSM ticket, and the terminate option is not used.
complete_prog_job [-job_status_file "job status file"] [-terminate "TRUE | FALSE"]

Arguments

ParameterTypeDescription
job_status_filestringSpecifies full path to the output Job Status container, which contains End-Job Certifier and CofCs. If not specified, information is printed in the log window. This parameter is optional.
terminatebooleanThis option terminates the HSM job even if there are devices left in any HSM ticket. This parameter is optional, if the number of devices in all tickets are exhausted.
Return TypeDescription
NoneNone

Error Codes

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

Supported Families

PolarFire®
SmartFusion® 2
IGLOO® 2
PolarFire SoC

Example

This example terminates HSM job:

complete_prog_job -terminate

See Also

  • get_job_status