📦 libnbd-doc

188 pages

L

libnbd(3)network block device (NBD) client library in userspace✨
libnbd-golang(3)how to use libnbd from Go✨
libnbd-ocaml(3)how to use libnbd from OCaml✨
libnbd-python(3)how to use libnbd from Python✨
libnbd-release-notes-1.10(1)release notes for libnbd 1.10✨
libnbd-release-notes-1.12(1)release notes for libnbd 1.12✨
libnbd-release-notes-1.14(1)release notes for libnbd 1.14✨
libnbd-release-notes-1.16(1)release notes for libnbd 1.16✨
libnbd-release-notes-1.18(1)release notes for libnbd 1.18✨
libnbd-release-notes-1.2(1)release notes for libnbd 1.2✨
libnbd-release-notes-1.20(1)release notes for libnbd 1.20✨
libnbd-release-notes-1.22(1)release notes for libnbd 1.22✨
libnbd-release-notes-1.24(1)release notes for libnbd 1.24✨
libnbd-release-notes-1.4(1)release notes for libnbd 1.4✨
libnbd-release-notes-1.6(1)release notes for libnbd 1.6✨
libnbd-release-notes-1.8(1)release notes for libnbd 1.8✨
libnbd-security(3)information about past security issues in libnbd✨

N

nbd_add_meta_context(3)ask server to negotiate metadata context✨
nbd_aio_block_status(3)send block status command, with 32-bit callback✨
nbd_aio_block_status_64(3)send block status command, with 64-bit callback✨
nbd_aio_block_status_filter(3)send filtered block status command to the NBD server✨
nbd_aio_cache(3)send cache (prefetch) command to the NBD server✨
nbd_aio_command_completed(3)check if the command completed✨
nbd_aio_connect(3)connect to the NBD server✨
nbd_aio_connect_command(3)connect to the NBD server✨
nbd_aio_connect_socket(3)connect directly to a connected socket✨
nbd_aio_connect_systemd_socket_activation(3)connect using systemd socket activation✨
nbd_aio_connect_tcp(3)connect to the NBD server over a TCP port✨
nbd_aio_connect_unix(3)connect to the NBD server over a Unix domain socket✨
nbd_aio_connect_uri(3)connect to an NBD URI✨
nbd_aio_connect_vsock(3)connect to the NBD server over AF_VSOCK socket✨
nbd_aio_disconnect(3)disconnect from the NBD server✨
nbd_aio_flush(3)send flush command to the NBD server✨
nbd_aio_get_direction(3)return the read or write direction✨
nbd_aio_get_fd(3)return file descriptor associated with this connection✨
nbd_aio_in_flight(3)check how many aio commands are still in flight✨
nbd_aio_is_closed(3)check if the connection is closed✨
nbd_aio_is_connecting(3)check if the connection is connecting or handshaking✨
nbd_aio_is_created(3)check if the connection has just been created✨
nbd_aio_is_dead(3)check if the connection is dead✨
nbd_aio_is_negotiating(3)check if connection is ready to send handshake option✨
nbd_aio_is_processing(3)check if the connection is processing a command✨
nbd_aio_is_ready(3)check if the connection is in the ready state✨
nbd_aio_notify_read(3)notify that the connection is readable✨
nbd_aio_notify_write(3)notify that the connection is writable✨
nbd_aio_opt_abort(3)end negotiation and close the connection✨
nbd_aio_opt_extended_headers(3)request the server to enable extended headers✨
nbd_aio_opt_go(3)end negotiation and move on to using an export✨
nbd_aio_opt_info(3)request the server for information about an export✨
nbd_aio_opt_list(3)request the server to list all exports during negotiation✨
nbd_aio_opt_list_meta_context(3)request list of available meta contexts, using implicit query✨
nbd_aio_opt_list_meta_context_queries(3)request list of available meta contexts, using explicit query✨
nbd_aio_opt_set_meta_context(3)select specific meta contexts, with implicit query list✨
nbd_aio_opt_set_meta_context_queries(3)select specific meta contexts, with explicit query list✨
nbd_aio_opt_starttls(3)request the server to initiate TLS✨
nbd_aio_opt_structured_reply(3)request the server to enable structured replies✨
nbd_aio_peek_command_completed(3)check if any command has completed✨
nbd_aio_pread(3)read from the NBD server✨
nbd_aio_pread_structured(3)read from the NBD server✨
nbd_aio_pwrite(3)write to the NBD server✨
nbd_aio_trim(3)send trim command to the NBD server✨
nbd_aio_zero(3)send write zeroes command to the NBD server✨
nbd_block_status(3)send block status command, with 32-bit callback✨
nbd_block_status_64(3)send block status command, with 64-bit callback✨
nbd_block_status_filter(3)send filtered block status command, with 64-bit callback✨
nbd_cache(3)send cache (prefetch) command to the NBD server✨
nbd_can_block_status_payload(3)does the server support the block status payload flag?✨
nbd_can_cache(3)does the server support the cache command?✨
nbd_can_df(3)does the server support the don't fragment flag to pread?✨
nbd_can_fast_zero(3)does the server support the fast zero flag?✨
nbd_can_flush(3)does the server support the flush command?✨
nbd_can_fua(3)does the server support the FUA flag?✨
nbd_can_meta_context(3)does the server support a specific meta context?✨
nbd_can_multi_conn(3)does the server support multi-conn?✨
nbd_can_trim(3)does the server support the trim command?✨
nbd_can_zero(3)does the server support the zero command?✨
nbd_clear_debug_callback(3)clear the debug callback✨
nbd_clear_meta_contexts(3)reset the list of requested meta contexts✨
nbd_close(3)create libnbd handles and fetch errors✨
nbd_connect_command(3)connect to NBD server command✨
nbd_connect_socket(3)connect directly to a connected socket✨
nbd_connect_systemd_socket_activation(3)connect using systemd socket activation✨
nbd_connect_tcp(3)connect to NBD server over a TCP port✨
nbd_connect_unix(3)connect to NBD server over a Unix domain socket✨
nbd_connect_uri(3)connect to NBD URI✨
nbd_connect_vsock(3)connect to NBD server over AF_VSOCK protocol✨
nbd_connection_state(3)return string describing the state of the connection✨
nbd_create(3)create libnbd handles and fetch errors✨
nbd_flush(3)send flush command to the NBD server✨
nbd_get_block_size(3)return a specific server block size constraint✨
nbd_get_canonical_export_name(3)return the canonical export name, if the server has one✨
nbd_get_debug(3)return the state of the debug flag✨
nbd_get_errno(3)create libnbd handles and fetch errors✨
nbd_get_error(3)create libnbd handles and fetch errors✨
nbd_get_export_description(3)return the export description, if the server has one✨
nbd_get_export_name(3)get the export name✨
nbd_get_extended_headers_negotiated(3)see if extended headers are in use✨
nbd_get_full_info(3)see if NBD_OPT_GO requests extra details✨
nbd_get_handle_name(3)get the handle name✨
nbd_get_handle_size(3)return an estimate of the memory allocated for the handle✨
nbd_get_handshake_flags(3)see which handshake flags are supported✨
nbd_get_meta_context(3)return the i'th meta context request✨
nbd_get_nr_meta_contexts(3)return the current number of requested meta contexts✨
nbd_get_opt_mode(3)return whether option mode was enabled✨
nbd_get_package_name(3)return the name of the library✨
nbd_get_pread_initialize(3)see whether libnbd pre-initializes read buffers✨
nbd_get_private_data(3)get the per-handle private data✨
nbd_get_protocol(3)return the NBD protocol variant✨
nbd_get_request_block_size(3)see if NBD_OPT_GO requests block size✨
nbd_get_request_extended_headers(3)see if extended headers are attempted✨
nbd_get_request_meta_context(3)see if connect automatically requests meta contexts✨
nbd_get_request_structured_replies(3)see if structured replies are attempted✨
nbd_get_size(3)return the export size✨
nbd_get_socket_activation_name(3)get the socket activation name✨
nbd_get_strict_mode(3)see which strictness flags are in effect✨
nbd_get_structured_replies_negotiated(3)see if structured replies are in use✨
nbd_get_subprocess_pid(3)get the process ID of the subprocess✨
nbd_get_tls(3)get the TLS request setting✨
nbd_get_tls_hostname(3)get the effective TLS hostname✨
nbd_get_tls_negotiated(3)find out if TLS was negotiated on a connection✨
nbd_get_tls_priority(3)get the current TLS priority✨
nbd_get_tls_username(3)get the current TLS username✨
nbd_get_tls_verify_peer(3)get whether we verify the identity of the server✨
nbd_get_uri(3)construct an NBD URI for a connection✨
nbd_get_version(3)return the version of the library✨
nbd_get_version_extra(3)return the extra version of the library✨
nbd_is_read_only(3)is the NBD export read-only?✨
nbd_is_rotational(3)is the NBD disk rotational (like a disk)?✨
nbd_is_uri(3)detect if a string could be an NBD URI✨
nbd_kill_subprocess(3)kill server running as a subprocess✨
nbd_opt_abort(3)end negotiation and close the connection✨
nbd_opt_extended_headers(3)request the server to enable extended headers✨
nbd_opt_go(3)end negotiation and move on to using an export✨
nbd_opt_info(3)request the server for information about an export✨
nbd_opt_list(3)request the server to list all exports during negotiation✨
nbd_opt_list_meta_context(3)list available meta contexts, using implicit query list✨
nbd_opt_list_meta_context_queries(3)list available meta contexts, using explicit query list✨
nbd_opt_set_meta_context(3)select specific meta contexts, using implicit query list✨
nbd_opt_set_meta_context_queries(3)select specific meta contexts, using explicit query list✨
nbd_opt_starttls(3)request the server to initiate TLS✨
nbd_opt_structured_reply(3)request the server to enable structured replies✨
nbd_poll(3)poll the handle once✨
nbd_poll2(3)poll the handle once, with fd✨
nbd_pread(3)read from the NBD server✨
nbd_pread_structured(3)read from the NBD server✨
nbd_pwrite(3)write to the NBD server✨
nbd_set_debug(3)set or clear the debug flag✨
nbd_set_debug_callback(3)set the debug callback✨
nbd_set_export_name(3)set the export name✨
nbd_set_full_info(3)control whether NBD_OPT_GO requests extra details✨
nbd_set_handle_name(3)set the handle name✨
nbd_set_handshake_flags(3)control use of handshake flags✨
nbd_set_opt_mode(3)control option mode, for pausing during option negotiation✨
nbd_set_pread_initialize(3)control whether libnbd pre-initializes read buffers✨
nbd_set_private_data(3)set the per-handle private data✨
nbd_set_request_block_size(3)control whether NBD_OPT_GO requests block size✨
nbd_set_request_extended_headers(3)control use of extended headers✨
nbd_set_request_meta_context(3)control whether connect automatically requests meta contexts✨
nbd_set_request_structured_replies(3)control use of structured replies✨
nbd_set_socket_activation_name(3)set the socket activation name✨
nbd_set_strict_mode(3)control how strictly to follow NBD protocol✨
nbd_set_tls(3)enable or require TLS (authentication and encryption)✨
nbd_set_tls_certificates(3)set the path to the TLS certificates directory✨
nbd_set_tls_hostname(3)set the TLS hostname✨
nbd_set_tls_priority(3)set the TLS priority string✨
nbd_set_tls_psk_file(3)set the TLS Pre-Shared Keys (PSK) filename✨
nbd_set_tls_username(3)set the TLS username✨
nbd_set_tls_verify_peer(3)set whether we verify the identity of the server✨
nbd_set_uri_allow_local_file(3)set the allowed transports in NBD URIs✨
nbd_set_uri_allow_tls(3)set the allowed TLS settings in NBD URIs✨
nbd_set_uri_allow_tls_priority(3)set if 'tls-priority' is allowed in NBD URIs✨
nbd_set_uri_allow_transports(3)set the allowed transports in NBD URIs✨
nbd_shutdown(3)disconnect from the NBD server✨
nbd_stats_bytes_received(3)statistics of bytes received over connection so far✨
nbd_stats_bytes_sent(3)statistics of bytes sent over connection so far✨
nbd_stats_chunks_received(3)statistics of chunks received over connection so far✨
nbd_stats_chunks_sent(3)statistics of chunks sent over connection so far✨
nbd_supports_tls(3)true if libnbd was compiled with support for TLS✨
nbd_supports_uri(3)true if libnbd was compiled with support for NBD URIs✨
nbd_supports_vsock(3)true if libnbd was compiled with support for AF_VSOCK✨
nbd_trim(3)send trim command to the NBD server✨
nbd_zero(3)send write zeroes command to the NBD server✨
nbdcopy(1)copy to and from an NBD server✨
nbddiscard(1)discard or zero all data on a Network Block Device✨
nbddump(1)hexdump the content of a disk over NBD✨
nbdinfo(1)display information and metadata about NBD servers and exports✨
nbdsh(1)network block device (NBD) shell✨
nbdzero(1)discard or zero all data on a Network Block Device✨