nvflare.fuel.hci.client package¶
Submodules¶
- nvflare.fuel.hci.client.api module
AdminAPIAdminAPI.auto_login()AdminAPI.check_command()AdminAPI.check_session_status_on_server()AdminAPI.close()AdminAPI.debug()AdminAPI.do_command()AdminAPI.fire_event()AdminAPI.fire_session_event()AdminAPI.is_ready()AdminAPI.login()AdminAPI.login_with_insecure()AdminAPI.logout()AdminAPI.register_command()AdminAPI.server_execute()AdminAPI.set_command_timeout()AdminAPI.unset_command_timeout()
ResultKey
- nvflare.fuel.hci.client.api_spec module
AdminAPISpecApiPocValueCommandContextCommandContext.get_api()CommandContext.get_bytes_receiver()CommandContext.get_bytes_sender()CommandContext.get_command()CommandContext.get_command_args()CommandContext.get_command_entry()CommandContext.get_command_name()CommandContext.get_command_result()CommandContext.get_custom_props()CommandContext.get_json_processor()CommandContext.get_meta()CommandContext.get_reply_processor()CommandContext.set_api()CommandContext.set_bytes_receiver()CommandContext.set_bytes_sender()CommandContext.set_command()CommandContext.set_command_args()CommandContext.set_command_entry()CommandContext.set_command_result()CommandContext.set_custom_props()CommandContext.set_json_processor()CommandContext.set_meta()CommandContext.set_reply_processor()
CommandCtxKeyCommandInfoReceiveBytesFromServerReplyProcessorReplyProcessor.process_bytes()ReplyProcessor.process_dict()ReplyProcessor.process_error()ReplyProcessor.process_shutdown()ReplyProcessor.process_string()ReplyProcessor.process_success()ReplyProcessor.process_table()ReplyProcessor.process_token()ReplyProcessor.protocol_error()ReplyProcessor.reply_done()ReplyProcessor.reply_start()
SendBytesToServerServiceFinderservice_address_changed_cb_signature()
- nvflare.fuel.hci.client.api_status module
- nvflare.fuel.hci.client.cli module
AdminClientAdminClient.cmdloop()AdminClient.complete()AdminClient.default()AdminClient.do_bye()AdminClient.do_help()AdminClient.do_lpwd()AdminClient.do_timeout()AdminClient.emptyline()AdminClient.flush()AdminClient.handle_event()AdminClient.postcmd()AdminClient.preloop()AdminClient.print_resp()AdminClient.run()AdminClient.session_signal_handler()AdminClient.write_dict()AdminClient.write_error()AdminClient.write_stdout()AdminClient.write_string()AdminClient.write_table()
- nvflare.fuel.hci.client.config module
- nvflare.fuel.hci.client.event module
EventContextEventHandlerEventPropKeyEventTypeEventType.AFTER_DOWNLOAD_FILEEventType.BEFORE_DOWNLOAD_FILEEventType.BEFORE_EXECUTE_CMDEventType.BEFORE_LOGINEventType.LOGIN_FAILUREEventType.LOGIN_SUCCESSEventType.SERVER_ADDR_OBTAINEDEventType.SESSION_CLOSEDEventType.SESSION_TIMEOUTEventType.SP_ADDR_CHANGEDEventType.TRYING_LOGINEventType.WAIT_FOR_SERVER_ADDR
- nvflare.fuel.hci.client.file_transfer module
FileTransferModuleFileTransferModule.download_binary_file()FileTransferModule.download_file()FileTransferModule.download_folder()FileTransferModule.download_text_file()FileTransferModule.generate_module_spec()FileTransferModule.get_spec()FileTransferModule.info()FileTransferModule.pull_binary_file()FileTransferModule.pull_folder()FileTransferModule.push_folder()FileTransferModule.upload_binary_file()FileTransferModule.upload_file()FileTransferModule.upload_text_file()
- nvflare.fuel.hci.client.fl_admin_api module
FLAdminAPIFLAdminAPI.abort()FLAdminAPI.abort_job()FLAdminAPI.cat_target()FLAdminAPI.check_status()FLAdminAPI.clone_job()FLAdminAPI.delete_job()FLAdminAPI.download_job()FLAdminAPI.get_active_sp()FLAdminAPI.get_available_apps_to_upload()FLAdminAPI.get_connected_client_list()FLAdminAPI.get_working_directory()FLAdminAPI.grep_target()FLAdminAPI.list_jobs()FLAdminAPI.list_sp()FLAdminAPI.ls_target()FLAdminAPI.promote_sp()FLAdminAPI.remove_client()FLAdminAPI.reset_errors()FLAdminAPI.restart()FLAdminAPI.set_timeout()FLAdminAPI.show_errors()FLAdminAPI.show_stats()FLAdminAPI.shutdown()FLAdminAPI.shutdown_system()FLAdminAPI.submit_job()FLAdminAPI.tail_target_log()FLAdminAPI.wait_until_client_status()FLAdminAPI.wait_until_server_stats()FLAdminAPI.wait_until_server_status()FLAdminAPI.write_error()
default_client_status_handling_cb()default_server_status_handling_cb()default_stats_handling_cb()wrap_with_return_exception_responses()
- nvflare.fuel.hci.client.fl_admin_api_constants module
- nvflare.fuel.hci.client.fl_admin_api_runner module
- nvflare.fuel.hci.client.fl_admin_api_spec module
APISyntaxErrorFLAdminAPIResponseFLAdminAPISpecFLAdminAPISpec.abort()FLAdminAPISpec.abort_job()FLAdminAPISpec.cat_target()FLAdminAPISpec.check_status()FLAdminAPISpec.clone_job()FLAdminAPISpec.delete_job()FLAdminAPISpec.download_job()FLAdminAPISpec.get_active_sp()FLAdminAPISpec.get_available_apps_to_upload()FLAdminAPISpec.get_connected_client_list()FLAdminAPISpec.get_working_directory()FLAdminAPISpec.grep_target()FLAdminAPISpec.list_jobs()FLAdminAPISpec.list_sp()FLAdminAPISpec.ls_target()FLAdminAPISpec.promote_sp()FLAdminAPISpec.remove_client()FLAdminAPISpec.reset_errors()FLAdminAPISpec.restart()FLAdminAPISpec.set_timeout()FLAdminAPISpec.show_errors()FLAdminAPISpec.show_stats()FLAdminAPISpec.shutdown()FLAdminAPISpec.submit_job()FLAdminAPISpec.tail_target_log()FLAdminAPISpec.wait_until_server_status()
TargetType
- nvflare.fuel.hci.client.overseer_service_finder module
- nvflare.fuel.hci.client.rr_service_finder module
- nvflare.fuel.hci.client.static_service_finder module