nvflare.tool.api_utils module

exception SystemStartTimeout

Bases: RuntimeError

abort_jobs(sess, job_ids)

get_running_job_ids(jobs: list) → List[str]

shutdown_system(prod_dir: str, username: str = 'admin@nvidia.com', secure_mode: bool = True, timeout_in_sec: int = 30, wait: bool = True, verbose: bool = True) → dict

shutdown_system_by_session(sess: Session, timeout_in_sec: int = 20, wait: bool = True, verbose: bool = True) → dict

wait_for_system_start(num_clients: int, prod_dir: str, username: str = 'admin', secure_mode: bool = False, second_to_wait: int = 10, timeout_in_sec: int = 30, poll_interval: float = 2.0, conn_timeout: float = 10.0, expected_clients: List[str] | None = None)