summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_ns_mgmt_delete_timeout.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_ns_mgmt_delete_timeout.2')
-rw-r--r--doc/man/nvme_ns_mgmt_delete_timeout.223
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/man/nvme_ns_mgmt_delete_timeout.2 b/doc/man/nvme_ns_mgmt_delete_timeout.2
new file mode 100644
index 0000000..49a61b7
--- /dev/null
+++ b/doc/man/nvme_ns_mgmt_delete_timeout.2
@@ -0,0 +1,23 @@
+.TH "nvme_ns_mgmt_delete_timeout" 9 "nvme_ns_mgmt_delete_timeout" "May 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_ns_mgmt_delete_timeout \- Delete a non attached namespace with timeout
+.SH SYNOPSIS
+.B "int" nvme_ns_mgmt_delete_timeout
+.BI "(int fd " ","
+.BI "__u32 nsid " ","
+.BI "__u32 timeout " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "nsid" 12
+Namespace identifier to delete
+.IP "timeout" 12
+Override the default timeout to this value in milliseconds;
+set to 0 to use the system default.
+.SH "DESCRIPTION"
+It is recommended that a namespace being deleted is not attached to any
+controller. Use the \fBnvme_ns_detach_ctrls\fP first if the namespace is still
+attached.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.