📦 libnvme-doc

1054 pages · page 1 of 6

N

nbft_control(2)NBFT Table - Control Descriptor (Figure 8)✨
nbft_control_flags(2)Control Descriptor Flags✨
nbft_desc_type(2)NBFT Elements - Descriptor Types (Figure 5)✨
nbft_discovery(2)Discovery Descriptor (Figure 24)✨
nbft_discovery_flags(2)Discovery Descriptor Flags✨
nbft_header(2)NBFT Table - Header (Figure 8)✨
nbft_heap_obj(2)NBFT Header Driver Signature✨
nbft_hfi(2)Host Fabric Interface (HFI) Descriptor (Figure 11)✨
nbft_hfi_flags(2)HFI Descriptor Flags✨
nbft_hfi_info_tcp(2)HFI Transport Info Descriptor - NVMe/TCP (Figure 13)✨
nbft_hfi_info_tcp_flags(2)HFI Transport Flags✨
nbft_host(2)Host Descriptor (Figure 9)✨
nbft_host_flags(2)Host Flags✨
nbft_info(2)The parsed NBFT table data.✨
nbft_info_discovery(2)Discovery Descriptor✨
nbft_info_hfi(2)Host Fabric Interface (HFI) Descriptor✨
nbft_info_hfi_info_tcp(2)HFI Transport Info Descriptor - NVMe/TCP✨
nbft_info_host(2)Host Descriptor✨
nbft_info_nid_type(2)Namespace Identifier Type (NIDT)✨
nbft_info_primary_admin_host_flag(2)Primary Administrative Host Descriptor Flags✨
nbft_info_security(2)Security Profile Descriptor✨
nbft_info_subsystem_ns(2)Subsystem Namespace (SSNS) info✨
nbft_security(2)Security Profile Descriptor (Figure 21)✨
nbft_security_flags(2)Security Profile Descriptor Flags (Figure 22)✨
nbft_security_secret_type(2)Security Profile Descriptor Secret Type✨
nbft_ssns(2)Subsystem Namespace (SSNS) Descriptor (Figure 15)✨
nbft_ssns_ext_info(2)Subsystem and Namespace Extended Information Descriptor (Figure 19)✨
nbft_ssns_ext_info_flags(2)Subsystem and Namespace Extended Information Descriptor Flags✨
nbft_ssns_flags(2)Subsystem and Namespace Specific Flags Field (Figure 16)✨
nbft_ssns_trflags(2)SSNS Transport Specific Flags Field (Figure 17)✨
nbft_trtype(2)NBFT Interface Transport Types (Figure 7)✨
nvme_acq(2)This field indicates the admin completion queue base address✨
nvme_admin_opcode(2)Known NVMe admin opcodes✨
nvme_admin_passthru(2)Submit an nvme passthrough command✨
nvme_admin_passthru64(2)Submit a 64-bit nvme passthrough command✨
nvme_ae_info_css_nvm(2)Asynchronous Event Information - I/O Command Specific Status✨
nvme_ae_info_error(2)Asynchronous Event Information - Error Status✨
nvme_ae_info_notice(2)Asynchronous Event Information - Notice✨
nvme_ae_info_smart(2)Asynchronous Event Information - SMART / Health Status✨
nvme_ae_type(2)Asynchronous Event Type✨
nvme_aggregate_endurance_group_event(2)Endurance Group Event Aggregate✨
nvme_aggregate_predictable_lat_event(2)Predictable Latency Event Aggregate Log Page✨
nvme_ana_group_desc(2)ANA Group Descriptor✨
nvme_ana_log(2)Asymmetric Namespace Access Log✨
nvme_ana_state(2)ANA Group Descriptor - Asymmetric Namespace Access State✨
nvme_apst_entry(2)Autonomous Power State Transition✨
nvme_aqa(2)This field indicates the admin queue attributes✨
nvme_asq(2)This field indicates the admin submission queue base address✨
nvme_ave_discover_log(2)AVE Discovery Log✨
nvme_ave_discover_log_entry(2)AVE Discovery Log Entry✨
nvme_ave_tr_record(2)AVE Transport Record✨
nvme_boot_partition(2)Boot Partition Log✨
nvme_boot_partition_info(2)This field indicates the boot partition information✨
nvme_bpinfo(2)This field indicates the boot partition information✨
nvme_bpmbl(2)This field indicates the boot partition memory buffer location✨
nvme_bprsel(2)This field indicates the boot partition read select✨
nvme_cap(2)This field indicates the controller capabilities register✨
nvme_capacity_config_desc(2)Capacity Configuration structure definitions✨
nvme_capacity_mgmt(2)Capacity management command✨
nvme_capacity_mgmt_args(2)Arguments for the NVMe Capacity Management command✨
nvme_cc(2)This field indicates the controller configuration✨
nvme_change_ns_event(2)Change Namespace Event Data✨
nvme_channel_config_desc(2)Channel Configuration Descriptor✨
nvme_clear_etdas(2)Clear the Extended Telemetry Data Area 4 Supported bit✨
nvme_cmb_size(2)Calculate size of the controller memory buffer✨
nvme_cmbebs(2)This field indicates the controller memory buffer elasticity buffer size✨
nvme_cmbloc(2)This field indicates the controller memory buffer location✨
nvme_cmbmsc(2)This field indicates the controller memory buffer memory space control✨
nvme_cmbsts(2)This field indicates the controller memory buffer status✨
nvme_cmbswtp(2)This field indicates the controller memory buffer sustained write throughput✨
nvme_cmbsz(2)This field indicates the controller memory buffer size✨
nvme_cmd_effects(2)Commands Supported and Effects✨
nvme_cmd_effects_log(2)Commands Supported and Effects Log✨
nvme_cmd_format_mset(2)Format NVM - Metadata Settings✨
nvme_cmd_format_pi(2)Format NVM - Protection Information✨
nvme_cmd_format_pil(2)Format NVM - Protection Information Location✨
nvme_cmd_format_ses(2)Format NVM - Secure Erase Settings✨
nvme_cmd_get_log_lid(2)Get Log Page -Log Page Identifiers✨
nvme_cmd_get_log_telemetry_host_lsp(2)Telemetry Host-Initiated log specific field✨
nvme_cmic(2)This field indicates the controller multi-path I/O and NS sharing capabilities✨
nvme_compare(2)Submit an nvme user compare command✨
nvme_connect_err(2)nvme connect error codes✨
nvme_constants(2)A place to stash various constant nvme values✨
nvme_copy(2)Copy command✨
nvme_copy_args(2)Arguments for the NVMe Copy command✨
nvme_copy_range(2)Copy - Source Range Entries Descriptor Format✨
nvme_copy_range_f1(2)Copy - Source Range Entries Descriptor Format 1h✨
nvme_copy_range_f2(2)Copy - Source Range Entries Descriptor Format 2h✨
nvme_copy_range_f3(2)Copy - Source Range Entries Descriptor Format 3h✨
nvme_copy_range_sopt(2)NVMe Copy Range Source Options✨
nvme_create_ctrl(2)Allocate an unconnected NVMe controller✨
nvme_create_root(2)Initialize root object✨
nvme_crto(2)This field indicates the controller ready timeouts✨
nvme_csi(2)Defined command set indicators✨
nvme_csts(2)This field indicates the controller status register✨
nvme_ctrl_config_match(2)Check if ctrl @c matches config params✨
nvme_ctrl_find(2)Locate an existing controller✨
nvme_ctrl_first_ns(2)Start namespace iterator✨
nvme_ctrl_first_path(2)Start path iterator✨
nvme_ctrl_for_each_ns(2)Traverse namespaces✨
nvme_ctrl_for_each_ns_safe(2)Traverse namespaces✨
nvme_ctrl_for_each_path(2)Traverse paths✨
nvme_ctrl_for_each_path_safe(2)Traverse paths✨
nvme_ctrl_get_address(2)Address string of a controller✨
nvme_ctrl_get_config(2)Fabrics configuration of a controller✨
nvme_ctrl_get_dhchap_host_key(2)Return host key✨
nvme_ctrl_get_dhchap_key(2)Return controller key✨
nvme_ctrl_get_fd(2)Get associated file descriptor✨
nvme_ctrl_get_firmware(2)Firmware string of a controller✨
nvme_ctrl_get_host_iface(2)Host interface name of a controller✨
nvme_ctrl_get_host_traddr(2)Host transport address of a controller✨
nvme_ctrl_get_keyring(2)Return keyring✨
nvme_ctrl_get_model(2)Model of a controller✨
nvme_ctrl_get_name(2)sysfs name of a controller✨
nvme_ctrl_get_numa_node(2)NUMA node of a controller✨
nvme_ctrl_get_phy_slot(2)PCI physical slot number of a controller✨
nvme_ctrl_get_queue_count(2)Queue count of a controller✨
nvme_ctrl_get_serial(2)Serial number of a controller✨
nvme_ctrl_get_sqsize(2)SQ size of a controller✨
nvme_ctrl_get_src_addr(2)Extract src_addr from the c->address string✨
nvme_ctrl_get_state(2)Running state of a controller✨
nvme_ctrl_get_subsysnqn(2)Subsystem NQN of a controller✨
nvme_ctrl_get_subsystem(2)Parent subsystem of a controller✨
nvme_ctrl_get_sysfs_dir(2)sysfs directory of a controller✨
nvme_ctrl_get_tls_key(2)Return Derive TLS PSK✨
nvme_ctrl_get_tls_key_identity(2)Return Derive TLS Identity✨
nvme_ctrl_get_traddr(2)Transport address of a controller✨
nvme_ctrl_get_transport(2)Transport type of a controller✨
nvme_ctrl_get_trsvcid(2)Transport service identifier of a controller✨
nvme_ctrl_identify(2)Issues an 'identify controller' command✨
nvme_ctrl_is_discovered(2)Returns the value of the 'discovered' flag✨
nvme_ctrl_is_discovery_ctrl(2)Check the 'discovery_ctrl' flag✨
nvme_ctrl_is_persistent(2)Returns the value of the 'persistent' flag✨
nvme_ctrl_is_unique_discovery_ctrl(2)Check the 'unique_discovery_ctrl' flag✨
nvme_ctrl_list(2)Controller List✨
nvme_ctrl_metadata_type(2)Controller Metadata Element Types✨
nvme_ctrl_next_ns(2)Next namespace iterator✨
nvme_ctrl_next_path(2)Next path iterator✨
nvme_ctrl_release_fd(2)Close fd and clear fd from controller object✨
nvme_ctrl_reset(2)Initiate a controller reset✨
nvme_ctrl_set_dhchap_host_key(2)Set host key✨
nvme_ctrl_set_dhchap_key(2)Set controller key✨
nvme_ctrl_set_discovered(2)Set the 'discovered' flag✨
nvme_ctrl_set_discovery_ctrl(2)Set the 'discovery_ctrl' flag✨
nvme_ctrl_set_keyring(2)Set keyring✨
nvme_ctrl_set_persistent(2)Set the 'persistent' flag✨
nvme_ctrl_set_tls_key(2)Set Derive TLS PSK✨
nvme_ctrl_set_tls_key_identity(2)Set Derive TLS Identity✨
nvme_ctrl_set_unique_discovery_ctrl(2)Set the 'unique_discovery_ctrl' flag✨
nvme_ctrls_filter(2)Filter for controllers✨
nvme_data_tfr(2)Data transfer direction of the command✨
nvme_default_host(2)Initializes the default host✨
nvme_describe_key_serial(2)Return key description✨
nvme_dev_self_test(2)Start or abort a self test✨
nvme_dev_self_test_args(2)Arguments for the NVMe Device Self Test command✨
nvme_dim_args(2)Arguments for the Discovery Information Management (DIM) command✨
nvme_directive_dtype(2)Directive Types✨
nvme_directive_receive_doper(2)Directive Receive Directive Operation✨
nvme_directive_recv(2)Receive directive specific data✨
nvme_directive_recv_args(2)Arguments for the NVMe Directive Receive command✨
nvme_directive_recv_identify_parameters(2)Directive receive identifier parameters✨
nvme_directive_recv_stream_allocate(2)Directive receive stream allocate✨
nvme_directive_recv_stream_parameters(2)Directive receive stream parameters✨
nvme_directive_recv_stream_status(2)Directive receive stream status✨
nvme_directive_send(2)Send directive command✨
nvme_directive_send_args(2)Arguments for the NVMe Directive Send command✨
nvme_directive_send_doper(2)Directive Send Directive Operation✨
nvme_directive_send_id_endir(2)Directive Send Enable Directive✨
nvme_directive_send_identify_endir(2)Enable Directive✨
nvme_directive_send_stream_release_identifier(2)Directive Send Stream release✨
nvme_directive_send_stream_release_resource(2)Directive Send Stream release resources✨
nvme_directive_types(2)Directives Supported or Enabled✨
nvme_disconnect_ctrl(2)Disconnect a controller✨
nvme_dispersed_ns_participating_nss_log(2)Dispersed Namespace Participating NVM Subsystems Log✨
nvme_dsm(2)Send an nvme data set management command✨
nvme_dsm_args(2)Arguments for the NVMe Dataset Management command✨
nvme_dsm_attributes(2)Dataset Management attributes✨
nvme_dsm_range(2)Dataset Management - Range Definition✨
nvme_dst_stc(2)Action taken by the Device Self-test command✨
nvme_dump_config(2)Print the JSON configuration✨
nvme_dump_tree(2)Dump internal object tree✨
nvme_eg_critical_warning_flags(2)Endurance Group Information Log - Critical Warning✨
nvme_eg_event_aggregate_log(2)Endurance Group Event Aggregate✨
nvme_end_grp_chan_desc(2)Endurance Group Channel Configuration Descriptor✨
nvme_end_grp_config_desc(2)Endurance Group Configuration Descriptor✨
nvme_endurance_group_log(2)Endurance Group Information Log✨
nvme_eom_lane_desc(2)EOM Lane Descriptor✨
nvme_eom_optional_data(2)EOM Optional Data Present Fields (Deprecated)✨
nvme_eom_optional_data_present(2)EOM Optional Data Present Fields✨
nvme_err_status_field(2)This field indicates the error information log entry status field✨
nvme_errno_to_string(2)Returns string describing nvme connect failures✨
nvme_error_log_page(2)Error Information Log Entry (Log Identifier 01h)✨
nvme_export_tls_key(2)Export a TLS key✨
nvme_export_tls_key_versioned(2)Export a TLS pre-shared key✨
nvme_fabrics_config(2)Defines all linux nvme fabrics initiator options✨
nvme_fabrics_uri(2)Parsed URI structure✨
nvme_fctype(2)Fabrics Command Types✨
nvme_fdp_config_desc(2)FDP Configuration Descriptor✨
nvme_fdp_config_fdpa(2)FDP Attributes✨
nvme_fdp_config_log(2)FDP Configurations Log Page✨