nvflare.private.fed.server.job_cmds module

class JobCommandModule

Bases: CommandModule, CommandUtil, BinaryTransfer

Command module with commands for job management.

MAX_RETURNED_JOB_LOG_BYTES = 5242880

abort_job(conn: Connection, args: List[str])

authorize_configure_job_log(conn: Connection, args: List[str])

authorize_job(conn: Connection, args: List[str])

authorize_job_file(conn: Connection, args: List[str])

Args: cmd_name tx_id job_id file_name [end]

authorize_job_id(conn: Connection, args: List[str])

clone_job(conn: Connection, args: List[str])

configure_job_log(conn: Connection, args: List[str])

delete_job(conn: Connection, args: List[str])

delete_job_id(conn: Connection, args: List[str])

do_app_command(conn: Connection, args: List[str])

download_job(conn: Connection, args: List[str])

Job download uses binary protocol for more efficient download. - Retrieve job data from job store. This puts job files (meta, data, and workspace) in a transfer folder - Returns job file names, a TX ID, and a command name for downloading files to the admin client - Admin client downloads received file names one by one. It signals the end of download in the last command.

download_job_components(conn: Connection, args: List[str])

Download additional job components (e.g., ERRORLOG_site-1) for a specified job.

Based on job download but downloads the additional components for a job that job download does not download.

get_job_log(conn: Connection, args: List[str])

get_job_meta(conn: Connection, args: List[str])

get_spec()

list_job_components(conn: Connection, args: List[str])

list_jobs(conn: Connection, args: List[str])

submit_job(conn: Connection, args: List[str])