nvflare.fuel.hci package

Subpackages

• nvflare.fuel.hci.client package
  • Submodules
    • nvflare.fuel.hci.client.api module
      • AdminAPI
      • ResultKey
    • nvflare.fuel.hci.client.api_spec module
      • AdminAPISpec
      • ApiPocValue
      • CommandContext
      • CommandCtxKey
      • CommandInfo
      • ReceiveBytesFromServer
      • ReplyProcessor
      • SendBytesToServer
      • ServiceFinder
      • service_address_changed_cb_signature()
    • nvflare.fuel.hci.client.api_status module
      • APIStatus
    • nvflare.fuel.hci.client.cli module
      • AdminClient
    • nvflare.fuel.hci.client.config module
      • FLAdminClientStarterConfigurator
    • nvflare.fuel.hci.client.event module
      • EventContext
      • EventHandler
      • EventPropKey
      • EventType
    • nvflare.fuel.hci.client.file_transfer module
      • FileTransferModule
    • nvflare.fuel.hci.client.fl_admin_api module
      • FLAdminAPI
      • 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
      • FLDetailKey
    • nvflare.fuel.hci.client.fl_admin_api_runner module
      • FLAdminAPIRunner
      • api_command_wrapper()
    • nvflare.fuel.hci.client.fl_admin_api_spec module
      • APISyntaxError
      • FLAdminAPIResponse
      • FLAdminAPISpec
      • TargetType
    • nvflare.fuel.hci.client.overseer_service_finder module
      • ServiceFinderByOverseer
    • nvflare.fuel.hci.client.rr_service_finder module
      • RRServiceFinder
    • nvflare.fuel.hci.client.static_service_finder module
      • StaticServiceFinder
  • Module contents
• nvflare.fuel.hci.server package
  • Submodules
    • nvflare.fuel.hci.server.audit module
      • CommandAudit
    • nvflare.fuel.hci.server.authz module
      • AuthzFilter
      • PreAuthzReturnCode
      • command_authz_func_signature()
      • command_handler_func_signature()
    • nvflare.fuel.hci.server.binary_transfer module
      • BinaryTransfer
    • nvflare.fuel.hci.server.builtin module
      • BuiltInCmdModule
      • new_command_register_with_builtin_module()
    • nvflare.fuel.hci.server.constants module
      • ConnProps
    • nvflare.fuel.hci.server.file_transfer module
      • FileTransferModule
    • nvflare.fuel.hci.server.hci module
      • AdminServer
      • initialize_hci()
    • nvflare.fuel.hci.server.login module
      • Authenticator
      • LoginModule
      • SimpleAuthenticator
    • nvflare.fuel.hci.server.reg module
      • CommandFilter
      • ServerCommandRegister
    • nvflare.fuel.hci.server.sess module
      • Session
      • SessionManager
  • Module contents
• nvflare.fuel.hci.tools package
  • Submodules
    • nvflare.fuel.hci.tools.admin module
      • main()
    • nvflare.fuel.hci.tools.authz_preview module
      • Commander
      • define_authz_preview_parser()
      • load_policy()
      • main()
      • run_command()
    • nvflare.fuel.hci.tools.make_pwd module
      • main()
  • Module contents

Submodules

• nvflare.fuel.hci.base64_utils module
  • b64str_to_binary_file()
  • b64str_to_bytes()
  • b64str_to_text_file()
  • binary_file_to_b64str()
  • bytes_to_b64str()
  • text_file_to_b64str()
• nvflare.fuel.hci.binary_proto module
  • DataGenerator
    • DataGenerator.data_size()
    • DataGenerator.generate()
  • DataProcessor
    • DataProcessor.finalize()
    • DataProcessor.process()
  • ExchangeHandler
    • ExchangeHandler.receive_and_parse()
  • GenerateDataFromFile
    • GenerateDataFromFile.data_size()
    • GenerateDataFromFile.generate()
  • MsgDataProcessor
    • MsgDataProcessor.finalize()
    • MsgDataProcessor.process()
  • Receiver
    • Receiver.recv()
  • Sender
    • Sender.sendall()
  • binary_footer()
  • binary_header()
  • receive_all()
  • send_binary_data()
  • send_binary_file()
• nvflare.fuel.hci.checksum module
  • Checksum
    • Checksum.result()
    • Checksum.update()
• nvflare.fuel.hci.chunk module
  • ChunkState
    • ChunkState.is_last()
    • ChunkState.unpack_header()
  • Header
    • Header.from_bytes()
    • Header.to_bytes()
  • Receiver
    • Receiver.receive()
  • Sender
    • Sender.close()
    • Sender.send()
  • chunk_it()
  • get_slice()
• nvflare.fuel.hci.cmd_arg_utils module
  • ArgValidator
    • ArgValidator.error()
    • ArgValidator.get_usage()
    • ArgValidator.validate()
  • get_file_extension()
  • join_args()
  • parse_command_line()
  • process_targets_into_str()
  • split_to_args()
  • validate_file_string()
  • validate_options_string()
  • validate_path_string()
  • validate_required_target_string()
  • validate_sp_string()
  • validate_text_file_name()
• nvflare.fuel.hci.conn module
  • Connection
    • Connection.append_any()
    • Connection.append_command()
    • Connection.append_dict()
    • Connection.append_error()
    • Connection.append_shutdown()
    • Connection.append_string()
    • Connection.append_success()
    • Connection.append_table()
    • Connection.append_token()
    • Connection.close()
    • Connection.flush()
    • Connection.flush_bytes()
    • Connection.update_meta()
  • receive_and_process()
  • receive_bytes_and_process()
• nvflare.fuel.hci.file_transfer_defs module
• nvflare.fuel.hci.proto module
  • Buffer
    • Buffer.append_command()
    • Buffer.append_dict()
    • Buffer.append_error()
    • Buffer.append_shutdown()
    • Buffer.append_string()
    • Buffer.append_success()
    • Buffer.append_table()
    • Buffer.append_token()
    • Buffer.encode()
    • Buffer.reset()
    • Buffer.update_meta()
  • ConfirmMethod
    • ConfirmMethod.AUTH
    • ConfirmMethod.PASSWORD
    • ConfirmMethod.USER_NAME
    • ConfirmMethod.YESNO
  • CredentialType
    • CredentialType.CERT
    • CredentialType.LOCAL_CERT
    • CredentialType.PASSWORD
  • InternalCommands
    • InternalCommands.CERT_LOGIN
    • InternalCommands.CHECK_SESSION
    • InternalCommands.GET_CMD_LIST
    • InternalCommands.LIST_SESSIONS
    • InternalCommands.LOGOUT
    • InternalCommands.PWD_LOGIN
    • InternalCommands.commands
    • InternalCommands.contains_commmand()
  • MetaKey
    • MetaKey.APP_NAME
    • MetaKey.CLIENTS
    • MetaKey.CLIENT_LAST_CONNECT_TIME
    • MetaKey.CLIENT_NAME
    • MetaKey.CLIENT_STATUS
    • MetaKey.CMD_NAME
    • MetaKey.CMD_PROPS
    • MetaKey.CMD_TIMEOUT
    • MetaKey.CUSTOM_PROPS
    • MetaKey.DATA_TYPE
    • MetaKey.DURATION
    • MetaKey.FILES
    • MetaKey.FOLDER_NAME
    • MetaKey.INFO
    • MetaKey.JOBS
    • MetaKey.JOB_DATA
    • MetaKey.JOB_DOWNLOAD_URL
    • MetaKey.JOB_ID
    • MetaKey.JOB_META
    • MetaKey.JOB_NAME
    • MetaKey.LOCATION
    • MetaKey.SERVER_START_TIME
    • MetaKey.SERVER_STATUS
    • MetaKey.STATUS
    • MetaKey.SUBMIT_TIME
    • MetaKey.TX_ID
    • MetaKey.WORKSPACE
  • MetaStatusValue
    • MetaStatusValue.CLIENTS_RUNNING
    • MetaStatusValue.ERROR
    • MetaStatusValue.INTERNAL_ERROR
    • MetaStatusValue.INVALID_JOB_DEFINITION
    • MetaStatusValue.INVALID_JOB_ID
    • MetaStatusValue.INVALID_TARGET
    • MetaStatusValue.JOB_NOT_RUNNING
    • MetaStatusValue.JOB_RUNNING
    • MetaStatusValue.NOT_AUTHENTICATED
    • MetaStatusValue.NOT_AUTHORIZED
    • MetaStatusValue.NO_CLIENTS
    • MetaStatusValue.NO_JOBS
    • MetaStatusValue.NO_REPLY
    • MetaStatusValue.OK
    • MetaStatusValue.SYNTAX_ERROR
  • ProtoKey
    • ProtoKey.COMMAND
    • ProtoKey.DATA
    • ProtoKey.DETAILS
    • ProtoKey.DICT
    • ProtoKey.ERROR
    • ProtoKey.META
    • ProtoKey.ROWS
    • ProtoKey.SHUTDOWN
    • ProtoKey.STATUS
    • ProtoKey.STRING
    • ProtoKey.SUCCESS
    • ProtoKey.TABLE
    • ProtoKey.TIME
    • ProtoKey.TOKEN
    • ProtoKey.TYPE
  • make_error()
  • make_meta()
  • validate_proto()
• nvflare.fuel.hci.reg module
  • CommandEntry
    • CommandEntry.full_command_name()
  • CommandModule
    • CommandModule.close()
    • CommandModule.generate_module_spec()
    • CommandModule.get_spec()
  • CommandModuleSpec
  • CommandRegister
    • CommandRegister.add_command()
    • CommandRegister.finalize()
    • CommandRegister.get_command_entries()
    • CommandRegister.register_module()
    • CommandRegister.register_module_spec()
  • CommandSpec
    • CommandSpec.valid_confirms
• nvflare.fuel.hci.security module
  • IdentityKey
    • IdentityKey.NAME
    • IdentityKey.ORG
    • IdentityKey.ROLE
  • get_certificate_common_name()
  • get_certificate_identity()
  • get_identity_info()
  • hash_password()
  • make_session_token()
  • verify_password()
• nvflare.fuel.hci.shell_cmd_val module
  • CatValidator
  • GrepValidator
  • HeadValidator
  • LsValidator
  • ShellCommandValidator
    • ShellCommandValidator.get_usage()
    • ShellCommandValidator.validate()
  • TailValidator
• nvflare.fuel.hci.table module
  • Table
    • Table.add_row()
    • Table.set_rows()
    • Table.write()
  • repeat_to_length()

Module contents