From 2822061d0e17d5acdbc46740b535021115f11071 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 9 Nov 2024 09:09:56 +0100 Subject: Adding upstream version 2.11. Signed-off-by: Daniel Baumann --- .github/workflows/appimage.yml | 2 +- .github/workflows/build.yml | 18 +- .github/workflows/coverage.yml | 2 +- .github/workflows/docs.yaml | 2 +- .github/workflows/run-nightly-tests.yml | 93 + CONTRIBUTING.md | 22 + Documentation/cmd-plugins.txt | 3 + Documentation/meson.build | 17 + Documentation/nvme-admin-passthru.1 | 4 +- Documentation/nvme-admin-passthru.html | 4 +- Documentation/nvme-ana-log.1 | 4 +- Documentation/nvme-ana-log.html | 4 +- Documentation/nvme-attach-ns.1 | 4 +- Documentation/nvme-attach-ns.html | 4 +- Documentation/nvme-boot-part-log.1 | 4 +- Documentation/nvme-boot-part-log.html | 4 +- Documentation/nvme-capacity-mgmt.1 | 4 +- Documentation/nvme-capacity-mgmt.html | 4 +- Documentation/nvme-changed-ns-list-log.1 | 4 +- Documentation/nvme-changed-ns-list-log.html | 4 +- Documentation/nvme-check-tls-key.txt | 6 + Documentation/nvme-cmdset-ind-id-ns.1 | 4 +- Documentation/nvme-cmdset-ind-id-ns.html | 4 +- Documentation/nvme-compare.1 | 4 +- Documentation/nvme-compare.html | 4 +- Documentation/nvme-connect-all.1 | 4 +- Documentation/nvme-connect-all.html | 4 +- Documentation/nvme-connect.1 | 24 +- Documentation/nvme-connect.html | 31 +- Documentation/nvme-connect.txt | 24 +- Documentation/nvme-copy.1 | 4 +- Documentation/nvme-copy.html | 4 +- Documentation/nvme-create-ns.1 | 4 +- Documentation/nvme-create-ns.html | 4 +- Documentation/nvme-dapustor-smart-log-add.1 | 108 ++ Documentation/nvme-dapustor-smart-log-add.html | 856 +++++++++ Documentation/nvme-dapustor-smart-log-add.txt | 65 + Documentation/nvme-delete-ns.1 | 4 +- Documentation/nvme-delete-ns.html | 4 +- Documentation/nvme-dera-stat.1 | 4 +- Documentation/nvme-dera-stat.html | 4 +- Documentation/nvme-detach-ns.1 | 4 +- Documentation/nvme-detach-ns.html | 4 +- Documentation/nvme-device-self-test.1 | 6 +- Documentation/nvme-device-self-test.html | 5 +- Documentation/nvme-device-self-test.txt | 2 + Documentation/nvme-dim.1 | 4 +- Documentation/nvme-dim.html | 4 +- Documentation/nvme-dir-receive.1 | 4 +- Documentation/nvme-dir-receive.html | 4 +- Documentation/nvme-dir-send.1 | 4 +- Documentation/nvme-dir-send.html | 4 +- Documentation/nvme-disconnect-all.1 | 4 +- Documentation/nvme-disconnect-all.html | 4 +- Documentation/nvme-disconnect.1 | 4 +- Documentation/nvme-disconnect.html | 4 +- Documentation/nvme-discover.1 | 4 +- Documentation/nvme-discover.html | 4 +- Documentation/nvme-dsm.1 | 4 +- Documentation/nvme-dsm.html | 4 +- Documentation/nvme-effects-log.1 | 4 +- Documentation/nvme-effects-log.html | 4 +- Documentation/nvme-endurance-event-agg-log.1 | 4 +- Documentation/nvme-endurance-event-agg-log.html | 4 +- Documentation/nvme-endurance-log.1 | 4 +- Documentation/nvme-endurance-log.html | 4 +- Documentation/nvme-error-log.1 | 4 +- Documentation/nvme-error-log.html | 4 +- Documentation/nvme-fdp-configs.1 | 4 +- Documentation/nvme-fdp-configs.html | 4 +- Documentation/nvme-fdp-events.1 | 4 +- Documentation/nvme-fdp-events.html | 4 +- Documentation/nvme-fdp-set-events.1 | 4 +- Documentation/nvme-fdp-set-events.html | 4 +- Documentation/nvme-fdp-stats.1 | 4 +- Documentation/nvme-fdp-stats.html | 4 +- Documentation/nvme-fdp-status.1 | 4 +- Documentation/nvme-fdp-status.html | 4 +- Documentation/nvme-fdp-update.1 | 4 +- Documentation/nvme-fdp-update.html | 4 +- Documentation/nvme-fdp-usage.1 | 4 +- Documentation/nvme-fdp-usage.html | 4 +- Documentation/nvme-fid-support-effects-log.1 | 4 +- Documentation/nvme-fid-support-effects-log.html | 4 +- Documentation/nvme-flush.1 | 4 +- Documentation/nvme-flush.html | 4 +- Documentation/nvme-format.1 | 4 +- Documentation/nvme-format.html | 4 +- Documentation/nvme-fw-commit.1 | 4 +- Documentation/nvme-fw-commit.html | 4 +- Documentation/nvme-fw-download.1 | 4 +- Documentation/nvme-fw-download.html | 4 +- Documentation/nvme-fw-log.1 | 4 +- Documentation/nvme-fw-log.html | 4 +- Documentation/nvme-gen-hostnqn.1 | 4 +- Documentation/nvme-gen-hostnqn.html | 4 +- Documentation/nvme-gen-tls-key.txt | 6 + Documentation/nvme-get-feature.1 | 11 +- Documentation/nvme-get-feature.html | 17 +- Documentation/nvme-get-feature.txt | 6 +- Documentation/nvme-get-lba-status.1 | 4 +- Documentation/nvme-get-lba-status.html | 4 +- Documentation/nvme-get-log.1 | 4 +- Documentation/nvme-get-log.html | 4 +- Documentation/nvme-get-ns-id.1 | 4 +- Documentation/nvme-get-ns-id.html | 4 +- Documentation/nvme-get-property.1 | 4 +- Documentation/nvme-get-property.html | 4 +- Documentation/nvme-help.1 | 4 +- Documentation/nvme-help.html | 4 +- Documentation/nvme-huawei-id-ctrl.1 | 4 +- Documentation/nvme-huawei-id-ctrl.html | 4 +- Documentation/nvme-huawei-list.1 | 4 +- Documentation/nvme-huawei-list.html | 4 +- Documentation/nvme-id-ctrl.1 | 4 +- Documentation/nvme-id-ctrl.html | 4 +- Documentation/nvme-id-domain.1 | 8 +- Documentation/nvme-id-domain.html | 10 +- Documentation/nvme-id-domain.txt | 6 +- Documentation/nvme-id-iocs.1 | 4 +- Documentation/nvme-id-iocs.html | 4 +- Documentation/nvme-id-ns.1 | 4 +- Documentation/nvme-id-ns.html | 4 +- Documentation/nvme-id-nvmset.1 | 4 +- Documentation/nvme-id-nvmset.html | 4 +- Documentation/nvme-inspur-nvme-vendor-log.1 | 4 +- Documentation/nvme-inspur-nvme-vendor-log.html | 4 +- Documentation/nvme-intel-id-ctrl.1 | 4 +- Documentation/nvme-intel-id-ctrl.html | 4 +- Documentation/nvme-intel-internal-log.1 | 4 +- Documentation/nvme-intel-internal-log.html | 4 +- Documentation/nvme-intel-lat-stats.1 | 4 +- Documentation/nvme-intel-lat-stats.html | 4 +- Documentation/nvme-intel-market-name.1 | 4 +- Documentation/nvme-intel-market-name.html | 4 +- Documentation/nvme-intel-smart-log-add.1 | 4 +- Documentation/nvme-intel-smart-log-add.html | 4 +- Documentation/nvme-intel-temp-stats.1 | 4 +- Documentation/nvme-intel-temp-stats.html | 4 +- Documentation/nvme-io-mgmt-recv.1 | 4 +- Documentation/nvme-io-mgmt-recv.html | 4 +- Documentation/nvme-io-mgmt-send.1 | 4 +- Documentation/nvme-io-mgmt-send.html | 4 +- Documentation/nvme-io-passthru.1 | 4 +- Documentation/nvme-io-passthru.html | 4 +- Documentation/nvme-lba-status-log.1 | 4 +- Documentation/nvme-lba-status-log.html | 4 +- Documentation/nvme-list-ctrl.1 | 4 +- Documentation/nvme-list-ctrl.html | 4 +- Documentation/nvme-list-endgrp.1 | 4 +- Documentation/nvme-list-endgrp.html | 4 +- Documentation/nvme-list-ns.1 | 4 +- Documentation/nvme-list-ns.html | 4 +- Documentation/nvme-list-subsys.1 | 4 +- Documentation/nvme-list-subsys.html | 4 +- Documentation/nvme-list.1 | 4 +- Documentation/nvme-list.html | 4 +- Documentation/nvme-lockdown.1 | 4 +- Documentation/nvme-lockdown.html | 4 +- Documentation/nvme-mi-cmd-support-effects-log.1 | 4 +- Documentation/nvme-mi-cmd-support-effects-log.html | 4 +- Documentation/nvme-micron-clear-pcie-errors.1 | 4 +- Documentation/nvme-micron-clear-pcie-errors.html | 4 +- Documentation/nvme-micron-internal-log.1 | 4 +- Documentation/nvme-micron-internal-log.html | 4 +- Documentation/nvme-micron-nand-stats.1 | 4 +- Documentation/nvme-micron-nand-stats.html | 4 +- Documentation/nvme-micron-pcie-stats.1 | 4 +- Documentation/nvme-micron-pcie-stats.html | 4 +- Documentation/nvme-micron-selective-download.1 | 4 +- Documentation/nvme-micron-selective-download.html | 4 +- Documentation/nvme-micron-smart-add-log.1 | 4 +- Documentation/nvme-micron-smart-add-log.html | 4 +- Documentation/nvme-micron-temperature-stats.1 | 4 +- Documentation/nvme-micron-temperature-stats.html | 4 +- Documentation/nvme-netapp-ontapdevices.1 | 4 +- Documentation/nvme-netapp-ontapdevices.html | 4 +- Documentation/nvme-netapp-smdevices.1 | 4 +- Documentation/nvme-netapp-smdevices.html | 4 +- Documentation/nvme-ns-descs.1 | 4 +- Documentation/nvme-ns-descs.html | 4 +- Documentation/nvme-ns-rescan.1 | 4 +- Documentation/nvme-ns-rescan.html | 4 +- Documentation/nvme-nvm-id-ctrl.1 | 4 +- Documentation/nvme-nvm-id-ctrl.html | 4 +- Documentation/nvme-nvme-mi-recv.1 | 4 +- Documentation/nvme-nvme-mi-recv.html | 4 +- Documentation/nvme-nvme-mi-send.1 | 4 +- Documentation/nvme-nvme-mi-send.html | 4 +- Documentation/nvme-ocp-clear-fw-activate-history.1 | 4 +- .../nvme-ocp-clear-fw-activate-history.html | 4 +- ...vme-ocp-clear-pcie-correctable-error-counters.1 | 4 +- ...-ocp-clear-pcie-correctable-error-counters.html | 4 +- Documentation/nvme-ocp-device-capability-log.1 | 4 +- Documentation/nvme-ocp-device-capability-log.html | 4 +- Documentation/nvme-ocp-eol-plp-failure-mode.1 | 4 +- Documentation/nvme-ocp-eol-plp-failure-mode.html | 4 +- Documentation/nvme-ocp-error-recovery-log.1 | 4 +- Documentation/nvme-ocp-error-recovery-log.html | 4 +- .../nvme-ocp-get-dssd-async-event-config.1 | 4 +- .../nvme-ocp-get-dssd-async-event-config.html | 4 +- .../nvme-ocp-get-dssd-power-state-feature.1 | 4 +- .../nvme-ocp-get-dssd-power-state-feature.html | 4 +- .../nvme-ocp-get-plp-health-check-interval.1 | 4 +- .../nvme-ocp-get-plp-health-check-interval.html | 4 +- Documentation/nvme-ocp-hardware-component-log.txt | 85 + Documentation/nvme-ocp-internal-log.1 | 4 +- Documentation/nvme-ocp-internal-log.html | 4 +- Documentation/nvme-ocp-latency-monitor-log.1 | 4 +- Documentation/nvme-ocp-latency-monitor-log.html | 4 +- .../nvme-ocp-set-dssd-async-event-config.1 | 4 +- .../nvme-ocp-set-dssd-async-event-config.html | 4 +- .../nvme-ocp-set-dssd-power-state-feature.1 | 4 +- .../nvme-ocp-set-dssd-power-state-feature.html | 4 +- .../nvme-ocp-set-plp-health-check-interval.1 | 4 +- .../nvme-ocp-set-plp-health-check-interval.html | 4 +- Documentation/nvme-ocp-set-telemetry-profile.1 | 4 +- Documentation/nvme-ocp-set-telemetry-profile.html | 4 +- Documentation/nvme-ocp-smart-add-log.1 | 4 +- Documentation/nvme-ocp-smart-add-log.html | 4 +- Documentation/nvme-ocp-telemetry-string-log-page.1 | 4 +- .../nvme-ocp-telemetry-string-log-page.html | 4 +- Documentation/nvme-ocp-unsupported-reqs-log.1 | 4 +- Documentation/nvme-ocp-unsupported-reqs-log.html | 4 +- Documentation/nvme-persistent-event-log.1 | 4 +- Documentation/nvme-persistent-event-log.html | 4 +- Documentation/nvme-pred-lat-event-agg-log.1 | 4 +- Documentation/nvme-pred-lat-event-agg-log.html | 4 +- Documentation/nvme-predictable-lat-log.1 | 4 +- Documentation/nvme-predictable-lat-log.html | 4 +- Documentation/nvme-primary-ctrl-caps.1 | 4 +- Documentation/nvme-primary-ctrl-caps.html | 4 +- Documentation/nvme-read.1 | 4 +- Documentation/nvme-read.html | 4 +- Documentation/nvme-reset.1 | 4 +- Documentation/nvme-reset.html | 4 +- Documentation/nvme-resv-acquire.1 | 4 +- Documentation/nvme-resv-acquire.html | 4 +- Documentation/nvme-resv-notif-log.1 | 4 +- Documentation/nvme-resv-notif-log.html | 4 +- Documentation/nvme-resv-register.1 | 4 +- Documentation/nvme-resv-register.html | 4 +- Documentation/nvme-resv-release.1 | 4 +- Documentation/nvme-resv-release.html | 4 +- Documentation/nvme-resv-report.1 | 4 +- Documentation/nvme-resv-report.html | 4 +- Documentation/nvme-rpmb.1 | 4 +- Documentation/nvme-rpmb.html | 4 +- Documentation/nvme-sanitize-log.1 | 4 +- Documentation/nvme-sanitize-log.html | 4 +- Documentation/nvme-sanitize.1 | 18 +- Documentation/nvme-sanitize.html | 26 +- Documentation/nvme-sanitize.txt | 12 +- .../nvme-seagate-clear-fw-activate-history.1 | 4 +- .../nvme-seagate-clear-fw-activate-history.html | 4 +- .../nvme-seagate-clear-pcie-correctable-errors.1 | 4 +- ...nvme-seagate-clear-pcie-correctable-errors.html | 4 +- .../nvme-seagate-cloud-SSD-plugin-version.1 | 4 +- .../nvme-seagate-cloud-SSD-plugin-version.html | 4 +- Documentation/nvme-seagate-get-ctrl-tele.1 | 4 +- Documentation/nvme-seagate-get-ctrl-tele.html | 4 +- Documentation/nvme-seagate-get-host-tele.1 | 4 +- Documentation/nvme-seagate-get-host-tele.html | 4 +- Documentation/nvme-seagate-help.1 | 4 +- Documentation/nvme-seagate-help.html | 4 +- Documentation/nvme-seagate-plugin-version.1 | 4 +- Documentation/nvme-seagate-plugin-version.html | 4 +- Documentation/nvme-seagate-version.1 | 4 +- Documentation/nvme-seagate-version.html | 4 +- .../nvme-seagate-vs-fw-activate-history.1 | 4 +- .../nvme-seagate-vs-fw-activate-history.html | 4 +- Documentation/nvme-seagate-vs-internal-log.1 | 4 +- Documentation/nvme-seagate-vs-internal-log.html | 4 +- Documentation/nvme-seagate-vs-log-page-sup.1 | 4 +- Documentation/nvme-seagate-vs-log-page-sup.html | 4 +- Documentation/nvme-seagate-vs-pcie-stats.1 | 4 +- Documentation/nvme-seagate-vs-pcie-stats.html | 4 +- Documentation/nvme-seagate-vs-smart-add-log.1 | 4 +- Documentation/nvme-seagate-vs-smart-add-log.html | 4 +- Documentation/nvme-seagate-vs-temperature-stats.1 | 4 +- .../nvme-seagate-vs-temperature-stats.html | 4 +- Documentation/nvme-security-recv.1 | 4 +- Documentation/nvme-security-recv.html | 4 +- Documentation/nvme-security-send.1 | 4 +- Documentation/nvme-security-send.html | 4 +- Documentation/nvme-self-test-log.1 | 4 +- Documentation/nvme-self-test-log.html | 4 +- Documentation/nvme-set-feature.1 | 4 +- Documentation/nvme-set-feature.html | 4 +- Documentation/nvme-set-property.1 | 4 +- Documentation/nvme-set-property.html | 4 +- Documentation/nvme-show-hostnqn.1 | 4 +- Documentation/nvme-show-hostnqn.html | 4 +- Documentation/nvme-show-regs.1 | 4 +- Documentation/nvme-show-regs.html | 4 +- Documentation/nvme-show-topology.1 | 4 +- Documentation/nvme-show-topology.html | 4 +- Documentation/nvme-smart-log.1 | 4 +- Documentation/nvme-smart-log.html | 4 +- .../nvme-solidigm-clear-fw-activate-history.1 | 96 ++ .../nvme-solidigm-clear-fw-activate-history.html | 831 +++++++++ .../nvme-solidigm-clear-fw-activate-history.txt | 48 + .../nvme-solidigm-clear-pcie-correctable-errors.1 | 96 ++ ...vme-solidigm-clear-pcie-correctable-errors.html | 832 +++++++++ ...nvme-solidigm-clear-pcie-correctable-errors.txt | 49 + .../nvme-solidigm-cloud-SSDplugin-version.1 | 64 + .../nvme-solidigm-cloud-SSDplugin-version.html | 794 +++++++++ .../nvme-solidigm-cloud-SSDplugin-version.txt | 29 + Documentation/nvme-solidigm-garbage-collect-log.1 | 96 ++ .../nvme-solidigm-garbage-collect-log.html | 825 +++++++++ .../nvme-solidigm-garbage-collect-log.txt | 44 + Documentation/nvme-solidigm-id-ctrl.1 | 161 ++ Documentation/nvme-solidigm-id-ctrl.html | 852 +++++++++ Documentation/nvme-solidigm-id-ctrl.txt | 74 + Documentation/nvme-solidigm-latency-tracking-log.1 | 166 ++ .../nvme-solidigm-latency-tracking-log.html | 901 ++++++++++ .../nvme-solidigm-latency-tracking-log.txt | 79 + Documentation/nvme-solidigm-log-page-directory.1 | 96 ++ .../nvme-solidigm-log-page-directory.html | 825 +++++++++ Documentation/nvme-solidigm-log-page-directory.txt | 44 + Documentation/nvme-solidigm-market-log.1 | 93 + Documentation/nvme-solidigm-market-log.html | 823 +++++++++ Documentation/nvme-solidigm-market-log.txt | 42 + Documentation/nvme-solidigm-parse-telemetry-log.1 | 183 ++ .../nvme-solidigm-parse-telemetry-log.html | 906 ++++++++++ .../nvme-solidigm-parse-telemetry-log.txt | 86 + Documentation/nvme-solidigm-smart-log-add.1 | 123 ++ Documentation/nvme-solidigm-smart-log-add.html | 847 +++++++++ Documentation/nvme-solidigm-smart-log-add.txt | 56 + Documentation/nvme-solidigm-temp-stats.1 | 93 + Documentation/nvme-solidigm-temp-stats.html | 825 +++++++++ Documentation/nvme-solidigm-temp-stats.txt | 44 + Documentation/nvme-solidigm-vs-drive-info.1 | 96 ++ Documentation/nvme-solidigm-vs-drive-info.html | 826 +++++++++ Documentation/nvme-solidigm-vs-drive-info.txt | 45 + .../nvme-solidigm-vs-fw-activate-history.1 | 94 + .../nvme-solidigm-vs-fw-activate-history.html | 821 +++++++++ .../nvme-solidigm-vs-fw-activate-history.txt | 39 + Documentation/nvme-solidigm-vs-internal-log.1 | 126 ++ Documentation/nvme-solidigm-vs-internal-log.html | 857 ++++++++++ Documentation/nvme-solidigm-vs-internal-log.txt | 59 + Documentation/nvme-solidigm-vs-smart-add-log.1 | 94 + Documentation/nvme-solidigm-vs-smart-add-log.html | 821 +++++++++ Documentation/nvme-solidigm-vs-smart-add-log.txt | 39 + Documentation/nvme-solidigm-workload-tracker.1 | 221 +++ Documentation/nvme-solidigm-workload-tracker.html | 947 ++++++++++ Documentation/nvme-solidigm-workload-tracker.txt | 104 ++ Documentation/nvme-subsystem-reset.1 | 4 +- Documentation/nvme-subsystem-reset.html | 4 +- Documentation/nvme-supported-log-pages.1 | 4 +- Documentation/nvme-supported-log-pages.html | 4 +- Documentation/nvme-telemetry-log.1 | 4 +- Documentation/nvme-telemetry-log.html | 4 +- Documentation/nvme-tls-key.1 | 4 +- Documentation/nvme-tls-key.html | 4 +- .../nvme-toshiba-clear-pcie-correctable-errors.1 | 4 +- ...nvme-toshiba-clear-pcie-correctable-errors.html | 4 +- Documentation/nvme-toshiba-vs-internal-log.1 | 4 +- Documentation/nvme-toshiba-vs-internal-log.html | 4 +- Documentation/nvme-toshiba-vs-smart-add-log.1 | 4 +- Documentation/nvme-toshiba-vs-smart-add-log.html | 4 +- Documentation/nvme-transcend-badblock.1 | 4 +- Documentation/nvme-transcend-badblock.html | 4 +- Documentation/nvme-transcend-healthvalue.1 | 4 +- Documentation/nvme-transcend-healthvalue.html | 4 +- Documentation/nvme-verify.1 | 4 +- Documentation/nvme-verify.html | 4 +- .../nvme-virtium-save-smart-to-vtview-log.1 | 4 +- .../nvme-virtium-save-smart-to-vtview-log.html | 4 +- Documentation/nvme-virtium-show-identify.1 | 4 +- Documentation/nvme-virtium-show-identify.html | 4 +- Documentation/nvme-wdc-cap-diag.1 | 4 +- Documentation/nvme-wdc-cap-diag.html | 4 +- Documentation/nvme-wdc-capabilities.1 | 4 +- Documentation/nvme-wdc-capabilities.html | 4 +- Documentation/nvme-wdc-clear-assert-dump.1 | 4 +- Documentation/nvme-wdc-clear-assert-dump.html | 4 +- Documentation/nvme-wdc-clear-fw-activate-history.1 | 4 +- .../nvme-wdc-clear-fw-activate-history.html | 4 +- .../nvme-wdc-clear-pcie-correctable-errors.1 | 4 +- .../nvme-wdc-clear-pcie-correctable-errors.html | 4 +- Documentation/nvme-wdc-cloud-SSD-plugin-version.1 | 4 +- .../nvme-wdc-cloud-SSD-plugin-version.html | 4 +- Documentation/nvme-wdc-cloud-boot-SSD-version.1 | 4 +- Documentation/nvme-wdc-cloud-boot-SSD-version.html | 4 +- Documentation/nvme-wdc-drive-essentials.1 | 4 +- Documentation/nvme-wdc-drive-essentials.html | 4 +- Documentation/nvme-wdc-drive-log.1 | 4 +- Documentation/nvme-wdc-drive-log.html | 4 +- Documentation/nvme-wdc-drive-resize.1 | 4 +- Documentation/nvme-wdc-drive-resize.html | 4 +- Documentation/nvme-wdc-enc-get-log.1 | 4 +- Documentation/nvme-wdc-enc-get-log.html | 4 +- Documentation/nvme-wdc-get-crash-dump.1 | 4 +- Documentation/nvme-wdc-get-crash-dump.html | 4 +- Documentation/nvme-wdc-get-dev-capabilities-log.1 | 4 +- .../nvme-wdc-get-dev-capabilities-log.html | 4 +- Documentation/nvme-wdc-get-drive-status.1 | 4 +- Documentation/nvme-wdc-get-drive-status.html | 4 +- Documentation/nvme-wdc-get-error-recovery-log.1 | 4 +- Documentation/nvme-wdc-get-error-recovery-log.html | 4 +- Documentation/nvme-wdc-get-latency-monitor-log.1 | 4 +- .../nvme-wdc-get-latency-monitor-log.html | 4 +- Documentation/nvme-wdc-get-pfail-dump.1 | 4 +- Documentation/nvme-wdc-get-pfail-dump.html | 4 +- Documentation/nvme-wdc-get-unsupported-reqs-log.1 | 4 +- .../nvme-wdc-get-unsupported-reqs-log.html | 4 +- Documentation/nvme-wdc-id-ctrl.1 | 4 +- Documentation/nvme-wdc-id-ctrl.html | 4 +- Documentation/nvme-wdc-log-page-directory.1 | 4 +- Documentation/nvme-wdc-log-page-directory.html | 4 +- Documentation/nvme-wdc-namespace-resize.1 | 4 +- Documentation/nvme-wdc-namespace-resize.html | 4 +- Documentation/nvme-wdc-purge-monitor.1 | 4 +- Documentation/nvme-wdc-purge-monitor.html | 4 +- Documentation/nvme-wdc-purge.1 | 4 +- Documentation/nvme-wdc-purge.html | 4 +- Documentation/nvme-wdc-vs-cloud-log.1 | 4 +- Documentation/nvme-wdc-vs-cloud-log.html | 4 +- Documentation/nvme-wdc-vs-device-waf.1 | 4 +- Documentation/nvme-wdc-vs-device-waf.html | 4 +- Documentation/nvme-wdc-vs-drive-info.1 | 4 +- Documentation/nvme-wdc-vs-drive-info.html | 4 +- .../nvme-wdc-vs-error-reason-identifier.1 | 4 +- .../nvme-wdc-vs-error-reason-identifier.html | 4 +- Documentation/nvme-wdc-vs-fw-activate-history.1 | 4 +- Documentation/nvme-wdc-vs-fw-activate-history.html | 4 +- Documentation/nvme-wdc-vs-hw-rev-log.1 | 4 +- Documentation/nvme-wdc-vs-hw-rev-log.html | 4 +- Documentation/nvme-wdc-vs-internal-log.1 | 4 +- Documentation/nvme-wdc-vs-internal-log.html | 4 +- Documentation/nvme-wdc-vs-nand-stats.1 | 4 +- Documentation/nvme-wdc-vs-nand-stats.html | 4 +- Documentation/nvme-wdc-vs-smart-add-log.1 | 4 +- Documentation/nvme-wdc-vs-smart-add-log.html | 4 +- .../nvme-wdc-vs-telemetry-controller-option.1 | 4 +- .../nvme-wdc-vs-telemetry-controller-option.html | 4 +- Documentation/nvme-wdc-vs-temperature-stats.1 | 4 +- Documentation/nvme-wdc-vs-temperature-stats.html | 4 +- Documentation/nvme-write-uncor.1 | 4 +- Documentation/nvme-write-uncor.html | 4 +- Documentation/nvme-write-zeroes.1 | 4 +- Documentation/nvme-write-zeroes.html | 4 +- Documentation/nvme-write.1 | 4 +- Documentation/nvme-write.html | 4 +- Documentation/nvme-zns-changed-zone-list.1 | 4 +- Documentation/nvme-zns-changed-zone-list.html | 4 +- Documentation/nvme-zns-close-zone.1 | 4 +- Documentation/nvme-zns-close-zone.html | 4 +- Documentation/nvme-zns-finish-zone.1 | 4 +- Documentation/nvme-zns-finish-zone.html | 4 +- Documentation/nvme-zns-id-ctrl.1 | 4 +- Documentation/nvme-zns-id-ctrl.html | 4 +- Documentation/nvme-zns-id-ns.1 | 4 +- Documentation/nvme-zns-id-ns.html | 4 +- Documentation/nvme-zns-offline-zone.1 | 4 +- Documentation/nvme-zns-offline-zone.html | 4 +- Documentation/nvme-zns-open-zone.1 | 4 +- Documentation/nvme-zns-open-zone.html | 4 +- Documentation/nvme-zns-report-zones.1 | 4 +- Documentation/nvme-zns-report-zones.html | 4 +- Documentation/nvme-zns-reset-zone.1 | 4 +- Documentation/nvme-zns-reset-zone.html | 4 +- Documentation/nvme-zns-set-zone-desc.1 | 4 +- Documentation/nvme-zns-set-zone-desc.html | 4 +- Documentation/nvme-zns-zone-append.1 | 4 +- Documentation/nvme-zns-zone-append.html | 4 +- Documentation/nvme-zns-zone-mgmt-recv.1 | 4 +- Documentation/nvme-zns-zone-mgmt-recv.html | 4 +- Documentation/nvme-zns-zone-mgmt-send.1 | 4 +- Documentation/nvme-zns-zone-mgmt-send.html | 4 +- Documentation/nvme.1 | 9 +- Documentation/nvme.html | 12 +- completions/_nvme | 105 +- completions/bash-nvme-completion.sh | 57 +- fabrics.c | 122 +- meson.build | 5 +- nvme-print-json.c | 438 ++--- nvme-print-stdout.c | 289 +++- nvme-print.c | 48 +- nvme-print.h | 15 +- nvme.c | 262 ++- nvmf-autoconnect/udev-rules/70-nvmf-keys.rules.in | 7 + plugins/dapustor/dapustor-nvme.c | 553 ++++++ plugins/dapustor/dapustor-nvme.h | 18 + plugins/fdp/fdp.c | 10 +- plugins/innogrit/innogrit-nvme.c | 501 +++--- plugins/innogrit/innogrit-nvme.h | 3 +- plugins/innogrit/typedef.h | 87 +- plugins/memblaze/memblaze-nvme.c | 2 +- plugins/meson.build | 4 +- plugins/netapp/netapp-nvme.c | 308 +++- plugins/ocp/meson.build | 9 + plugins/ocp/ocp-fw-activation-history.c | 129 +- plugins/ocp/ocp-fw-activation-history.h | 32 +- plugins/ocp/ocp-hardware-component-log.c | 288 ++++ plugins/ocp/ocp-hardware-component-log.h | 64 + plugins/ocp/ocp-nvme.c | 1809 +++----------------- plugins/ocp/ocp-nvme.h | 200 ++- plugins/ocp/ocp-print-binary.c | 54 + plugins/ocp/ocp-print-json.c | 851 +++++++++ plugins/ocp/ocp-print-stdout.c | 710 ++++++++ plugins/ocp/ocp-print.c | 81 + plugins/ocp/ocp-print.h | 51 + plugins/ocp/ocp-smart-extended-log.c | 239 +-- plugins/ocp/ocp-smart-extended-log.h | 40 + plugins/ocp/ocp-telemetry-decode.c | 471 +++-- plugins/ocp/ocp-telemetry-decode.h | 32 +- plugins/sed/sedopal_cmd.c | 18 +- plugins/solidigm/solidigm-internal-logs.c | 70 +- plugins/solidigm/solidigm-nvme.h | 2 +- plugins/solidigm/solidigm-telemetry.c | 13 +- plugins/solidigm/solidigm-util.c | 16 + plugins/solidigm/solidigm-util.h | 5 +- plugins/solidigm/solidigm-workload-tracker.c | 365 ++-- plugins/wdc/wdc-nvme.c | 55 +- plugins/wdc/wdc-nvme.h | 2 +- scripts/release.sh | 2 +- subprojects/libnvme.wrap | 2 +- tests/nvme_attach_detach_ns_test.py | 6 +- tests/nvme_compare_test.py | 11 + tests/nvme_copy_test.py | 1 + tests/nvme_create_max_ns_test.py | 13 +- tests/nvme_ctrl_reset_test.py | 2 + tests/nvme_format_test.py | 13 +- tests/nvme_get_features_test.py | 2 + tests/nvme_get_lba_status_test.py | 7 +- tests/nvme_lba_status_log_test.py | 2 + tests/nvme_smart_log_test.py | 2 +- tests/nvme_test.py | 128 +- util/logging.h | 6 + util/types.c | 2 +- util/types.h | 1 + 533 files changed, 24034 insertions(+), 4006 deletions(-) create mode 100644 .github/workflows/run-nightly-tests.yml create mode 100644 Documentation/nvme-dapustor-smart-log-add.1 create mode 100644 Documentation/nvme-dapustor-smart-log-add.html create mode 100644 Documentation/nvme-dapustor-smart-log-add.txt create mode 100644 Documentation/nvme-ocp-hardware-component-log.txt create mode 100644 Documentation/nvme-solidigm-clear-fw-activate-history.1 create mode 100644 Documentation/nvme-solidigm-clear-fw-activate-history.html create mode 100644 Documentation/nvme-solidigm-clear-fw-activate-history.txt create mode 100644 Documentation/nvme-solidigm-clear-pcie-correctable-errors.1 create mode 100644 Documentation/nvme-solidigm-clear-pcie-correctable-errors.html create mode 100644 Documentation/nvme-solidigm-clear-pcie-correctable-errors.txt create mode 100644 Documentation/nvme-solidigm-cloud-SSDplugin-version.1 create mode 100644 Documentation/nvme-solidigm-cloud-SSDplugin-version.html create mode 100644 Documentation/nvme-solidigm-cloud-SSDplugin-version.txt create mode 100644 Documentation/nvme-solidigm-garbage-collect-log.1 create mode 100644 Documentation/nvme-solidigm-garbage-collect-log.html create mode 100644 Documentation/nvme-solidigm-garbage-collect-log.txt create mode 100644 Documentation/nvme-solidigm-id-ctrl.1 create mode 100644 Documentation/nvme-solidigm-id-ctrl.html create mode 100644 Documentation/nvme-solidigm-id-ctrl.txt create mode 100644 Documentation/nvme-solidigm-latency-tracking-log.1 create mode 100644 Documentation/nvme-solidigm-latency-tracking-log.html create mode 100644 Documentation/nvme-solidigm-latency-tracking-log.txt create mode 100644 Documentation/nvme-solidigm-log-page-directory.1 create mode 100644 Documentation/nvme-solidigm-log-page-directory.html create mode 100644 Documentation/nvme-solidigm-log-page-directory.txt create mode 100644 Documentation/nvme-solidigm-market-log.1 create mode 100644 Documentation/nvme-solidigm-market-log.html create mode 100644 Documentation/nvme-solidigm-market-log.txt create mode 100644 Documentation/nvme-solidigm-parse-telemetry-log.1 create mode 100644 Documentation/nvme-solidigm-parse-telemetry-log.html create mode 100644 Documentation/nvme-solidigm-parse-telemetry-log.txt create mode 100644 Documentation/nvme-solidigm-smart-log-add.1 create mode 100644 Documentation/nvme-solidigm-smart-log-add.html create mode 100644 Documentation/nvme-solidigm-smart-log-add.txt create mode 100644 Documentation/nvme-solidigm-temp-stats.1 create mode 100644 Documentation/nvme-solidigm-temp-stats.html create mode 100644 Documentation/nvme-solidigm-temp-stats.txt create mode 100644 Documentation/nvme-solidigm-vs-drive-info.1 create mode 100644 Documentation/nvme-solidigm-vs-drive-info.html create mode 100644 Documentation/nvme-solidigm-vs-drive-info.txt create mode 100644 Documentation/nvme-solidigm-vs-fw-activate-history.1 create mode 100644 Documentation/nvme-solidigm-vs-fw-activate-history.html create mode 100644 Documentation/nvme-solidigm-vs-fw-activate-history.txt create mode 100644 Documentation/nvme-solidigm-vs-internal-log.1 create mode 100644 Documentation/nvme-solidigm-vs-internal-log.html create mode 100644 Documentation/nvme-solidigm-vs-internal-log.txt create mode 100644 Documentation/nvme-solidigm-vs-smart-add-log.1 create mode 100644 Documentation/nvme-solidigm-vs-smart-add-log.html create mode 100644 Documentation/nvme-solidigm-vs-smart-add-log.txt create mode 100644 Documentation/nvme-solidigm-workload-tracker.1 create mode 100644 Documentation/nvme-solidigm-workload-tracker.html create mode 100644 Documentation/nvme-solidigm-workload-tracker.txt create mode 100644 nvmf-autoconnect/udev-rules/70-nvmf-keys.rules.in create mode 100644 plugins/dapustor/dapustor-nvme.c create mode 100644 plugins/dapustor/dapustor-nvme.h create mode 100644 plugins/ocp/ocp-hardware-component-log.c create mode 100644 plugins/ocp/ocp-hardware-component-log.h create mode 100644 plugins/ocp/ocp-print-binary.c create mode 100644 plugins/ocp/ocp-print-json.c create mode 100644 plugins/ocp/ocp-print-stdout.c create mode 100644 plugins/ocp/ocp-print.c create mode 100644 plugins/ocp/ocp-print.h diff --git a/.github/workflows/appimage.yml b/.github/workflows/appimage.yml index c7b92f7..9768c70 100644 --- a/.github/workflows/appimage.yml +++ b/.github/workflows/appimage.yml @@ -14,7 +14,7 @@ jobs: name: build AppImage runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian:latest + image: ghcr.io/linux-nvme/debian:latest steps: - uses: actions/checkout@v4 with: diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 66b3811..a52f129 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -17,7 +17,7 @@ jobs: compiler: [gcc, clang] buildtype: [debug, release] container: - image: ghcr.io/igaw/linux-nvme/debian.python:latest + image: ghcr.io/linux-nvme/debian.python:latest steps: - uses: actions/checkout@v4 - name: build @@ -43,10 +43,16 @@ jobs: - uses: actions/checkout@v4 - name: enable foreign arch uses: dbhi/qus/action@main + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} - name: compile and run unit tests uses: mosteo-actions/docker-run@v2 with: - image: ghcr.io/igaw/linux-nvme/ubuntu-cross-${{ matrix.arch }}:latest + image: ghcr.io/linux-nvme/ubuntu-cross-${{ matrix.arch }}:latest guest-dir: /build host-dir: ${{ github.workspace }} command: | @@ -65,7 +71,7 @@ jobs: name: fallback shared libraries runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian:latest + image: ghcr.io/linux-nvme/debian:latest if: github.ref == 'refs/heads/master' steps: - uses: actions/checkout@v4 @@ -83,7 +89,7 @@ jobs: name: muon minimal static runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian:latest + image: ghcr.io/linux-nvme/debian:latest steps: - uses: actions/checkout@v4 - name: build @@ -94,7 +100,7 @@ jobs: name: make static runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian:latest + image: ghcr.io/linux-nvme/debian:latest steps: - uses: actions/checkout@v4 - name: build @@ -105,7 +111,7 @@ jobs: name: build libnvme and nvme-cli separately runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian:latest + image: ghcr.io/linux-nvme/debian:latest steps: - uses: actions/checkout@v4 - name: build diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml index 875ed6d..20c69fa 100644 --- a/.github/workflows/coverage.yml +++ b/.github/workflows/coverage.yml @@ -11,7 +11,7 @@ jobs: name: code coverage runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian.python:latest + image: ghcr.io/linux-nvme/debian.python:latest steps: - uses: actions/checkout@v4 - name: build diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 89fbd67..465bb26 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -18,7 +18,7 @@ jobs: name: build documentation runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian:latest + image: ghcr.io/linux-nvme/debian:latest steps: - uses: actions/checkout@v4 - name: build diff --git a/.github/workflows/run-nightly-tests.yml b/.github/workflows/run-nightly-tests.yml new file mode 100644 index 0000000..d525986 --- /dev/null +++ b/.github/workflows/run-nightly-tests.yml @@ -0,0 +1,93 @@ +--- +name: run-nightly-tests + +on: + workflow_dispatch: + schedule: + - cron: '0 01 * * *' + +jobs: + nightly-tests: + runs-on: nvme-nvm + steps: + - name: Output kernel version + run: | + uname -a + - name: Clean up test device + run: | + #BDEV0 is an environment variable of the self-hosted runner instance + #that contains a valid nvme ctrl name which is capable of the nvm + #command set. + CONTROLLER=$(echo /dev/${BDEV0} | sed 's/n[0-9]*$//') + sudo nvme delete-ns $CONTROLLER -n 0xffffffff + sudo nvme format $CONTROLLER -n 0xffffffff -l 0 -f + SIZE=$(sudo nvme id-ctrl $CONTROLLER --output-format=json | jq -r '{tnvmcap} | .[]' | awk '{print $1/512}') + sudo nvme create-ns -s $SIZE -c $SIZE -f 0 -d 0 --csi=0 $CONTROLLER + sudo nvme attach-ns $CONTROLLER -n 1 -c 0 + - uses: actions/checkout@v4 + - name: Install dependencies + run: | + sudo apt-get update + sudo apt-get install --no-install-recommends -y \ + meson gcc pkg-config git libjson-c-dev libssl-dev libkeyutils-dev \ + libdbus-1-dev libpython3-dev pipx python3-dev swig xz-utils + pipx ensurepath + sudo PIPX_BIN_DIR=/usr/local/bin pipx install nose2 + sudo PIPX_BIN_DIR=/usr/local/bin pipx install flake8 + sudo PIPX_BIN_DIR=/usr/local/bin pipx install mypy + sudo PIPX_BIN_DIR=/usr/local/bin pipx install autopep8 + sudo PIPX_BIN_DIR=/usr/local/bin pipx install isort + - name: Build and install nvme-cli + run: | + scripts/build.sh -b release -c gcc + sudo meson install -C .build-ci + sudo ldconfig /usr/local/lib64 + - name: Overwrite test config + run: | + CONTROLLER=$(echo /dev/${BDEV0} | sed 's/n[0-9]*$//') + cat > tests/config.json << EOF + { + "controller" : "$CONTROLLER", + "ns1": "/dev/${BDEV0}", + "log_dir": "tests/nvmetests/" + } + EOF + - name: Run on device tests + run: | + sudo nose2 --verbose --start-dir tests \ + nvme_attach_detach_ns_test \ + nvme_compare_test \ + nvme_copy_test \ + nvme_create_max_ns_test \ + nvme_ctrl_reset_test \ + nvme_dsm_test \ + nvme_error_log_test \ + nvme_flush_test \ + nvme_format_test \ + nvme_fw_log_test \ + nvme_get_features_test \ + nvme_get_lba_status_test \ + nvme_id_ctrl_test \ + nvme_id_ns_test \ + nvme_lba_status_log_test \ + nvme_read_write_test \ + nvme_smart_log_test \ + nvme_verify_test \ + nvme_writeuncor_test \ + nvme_writezeros_test + - name: Upload logs + uses: actions/upload-artifact@v4 + if: always() + with: + name: logs files + path: | + ./tests/nvmetests/**/*.log + - name: Clean up test device + if: always() + run: | + CONTROLLER=$(echo /dev/${BDEV0} | sed 's/n[0-9]*$//') + sudo nvme delete-ns $CONTROLLER -n 0xffffffff + sudo nvme format $CONTROLLER -n 0xffffffff -l 0 -f + SIZE=$(sudo nvme id-ctrl $CONTROLLER --output-format=json | jq -r '{tnvmcap} | .[]' | awk '{print $1/512}') + sudo nvme create-ns -s $SIZE -c $SIZE -f 0 -d 0 --csi=0 $CONTROLLER + sudo nvme attach-ns $CONTROLLER -n 1 -c 0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cde8527..df0e8e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,6 +19,28 @@ Please feel free to use the github forums to ask for comments & questions on your code before submitting a pull request. The NVMe CLI project uses the common *fork and merge* workflow used by most GitHub-hosted projects. +#### Commit conventions + +The project follows the Linux kernel mailing list workflow, +thus commit messages should be structured like this: +``` +: + + + +Signed-off-by: My Name/alias +``` + +Example: + +``` +doc: added commit conventions to contribution guidelines + +Show new contributors the project's commit guidelines + +Signed-off-by: John Doe +``` + ### Bug Reports Bugs for the NVM Library project are tracked in our [GitHub Issues Database](https://github.com/linux-nvme/nvme-cli/issues). diff --git a/Documentation/cmd-plugins.txt b/Documentation/cmd-plugins.txt index 338425e..2e80bfc 100644 --- a/Documentation/cmd-plugins.txt +++ b/Documentation/cmd-plugins.txt @@ -204,3 +204,6 @@ linknvme:nvme-zns-zrwa-flush-zone[1]:: linknvme:nvme-inspur-nvme-vendor-log[1]:: NVMe Inspur Device Vendor log page request + +linknvme:nvme-dapustor-smart-log-add[1]:: + NVMe DapuStor Additional SMART log page diff --git a/Documentation/meson.build b/Documentation/meson.build index 1478134..65495e3 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -14,6 +14,7 @@ adoc_sources = [ 'nvme-connect-all', 'nvme-copy', 'nvme-create-ns', + 'nvme-dapustor-smart-log-add', 'nvme-delete-ns', 'nvme-dera-stat', 'nvme-detach-ns', @@ -142,6 +143,22 @@ adoc_sources = [ 'nvme-show-regs', 'nvme-show-topology', 'nvme-smart-log', + 'nvme-solidigm-clear-fw-activate-history', + 'nvme-solidigm-clear-pcie-correctable-errors', + 'nvme-solidigm-cloud-SSDplugin-version', + 'nvme-solidigm-garbage-collect-log', + 'nvme-solidigm-id-ctrl', + 'nvme-solidigm-latency-tracking-log', + 'nvme-solidigm-log-page-directory', + 'nvme-solidigm-market-log', + 'nvme-solidigm-parse-telemetry-log', + 'nvme-solidigm-smart-log-add', + 'nvme-solidigm-temp-stats', + 'nvme-solidigm-vs-drive-info', + 'nvme-solidigm-vs-fw-activate-history', + 'nvme-solidigm-vs-internal-log', + 'nvme-solidigm-vs-smart-add-log', + 'nvme-solidigm-workload-tracker', 'nvme-subsystem-reset', 'nvme-supported-log-pages', 'nvme-telemetry-log', diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index a1d33c6..25576c9 100644 --- a/Documentation/nvme-admin-passthru.1 +++ b/Documentation/nvme-admin-passthru.1 @@ -2,12 +2,12 @@ .\" Title: nvme-admin-passthru .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 08/05/2024 +.\" Date: 10/31/2024 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ADMIN\-PASSTHR" "1" "08/05/2024" "NVMe" "NVMe Manual" +.TH "NVME\-ADMIN\-PASSTHR" "1" "10/31/2024" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-admin-passthru.html b/Documentation/nvme-admin-passthru.html index d918999..1ae7d89 100644 --- a/Documentation/nvme-admin-passthru.html +++ b/Documentation/nvme-admin-passthru.html @@ -4,7 +4,7 @@ - + nvme-admin-passthru(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme dapustor smart-log-add <device> [--namespace-id=<nsid> | -n <nsid>]
+                        [--raw-binary | -b] [--json | -j]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the NVMe DapuStor Additional SMART log page from the device and +provides the returned structure.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+

On success, the returned smart log structure may be returned in one of +several ways depending on the option flags; the structure may parsed by +the program and printed in a readable format or the raw buffer may be +printed to stdout for another program to parse.

+
+
+
+

OPTIONS

+
+
+
+-n <nsid> +
+
+--namespace-id=<nsid> +
+
+

+ Retrieve the Additional SMART log for the given nsid. This is + optional and its success may depend on the device’s capabilities + to provide this log on a per-namespace basis (see the NVMe + Identify Controller for this capability). The default nsid to + use is 0xffffffff for the device global SMART log. +

+
+
+-b +
+
+--raw-binary +
+
+

+ Print the raw DapuStor Additional SMART log buffer to stdout. +

+
+
+-j +
+
+--json +
+
+

+ Dump output in json format. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Print the DapuStor Additional SMART log page in a human readable format: +

    +
    +
    +
    # nvme dapustor smart-log-add /dev/nvme0
    +
    +
    • +
  • +

    +Print the raw DapuStor Additional SMART log to a file: +

    +
    +
    +
    # nvme dapustor smart-log-add /dev/nvme0 --raw-binary > smart_log.raw
    +
    +

    It is probably a bad idea to not redirect stdout when using this mode.

    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-dapustor-smart-log-add.txt b/Documentation/nvme-dapustor-smart-log-add.txt new file mode 100644 index 0000000..0c67a21 --- /dev/null +++ b/Documentation/nvme-dapustor-smart-log-add.txt @@ -0,0 +1,65 @@ +nvme-dapustor-smart-log-add(1) +============================== + +NAME +---- +nvme-dapustor-smart-log-add - Send NVMe DapuStor Additional SMART log page request, +returns result and log + +SYNOPSIS +-------- +[verse] +'nvme dapustor smart-log-add' [--namespace-id= | -n ] + [--raw-binary | -b] [--json | -j] + +DESCRIPTION +----------- +Retrieves the NVMe DapuStor Additional SMART log page from the device and +provides the returned structure. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +On success, the returned smart log structure may be returned in one of +several ways depending on the option flags; the structure may parsed by +the program and printed in a readable format or the raw buffer may be +printed to stdout for another program to parse. + +OPTIONS +------- +-n :: +--namespace-id=:: + Retrieve the Additional SMART log for the given nsid. This is + optional and its success may depend on the device's capabilities + to provide this log on a per-namespace basis (see the NVMe + Identify Controller for this capability). The default nsid to + use is 0xffffffff for the device global SMART log. + +-b:: +--raw-binary:: + Print the raw DapuStor Additional SMART log buffer to stdout. + +-j:: +--json:: + Dump output in json format. + +EXAMPLES +-------- +* Print the DapuStor Additional SMART log page in a human readable format: ++ +------------ +# nvme dapustor smart-log-add /dev/nvme0 +------------ ++ + +* Print the raw DapuStor Additional SMART log to a file: ++ +------------ +# nvme dapustor smart-log-add /dev/nvme0 --raw-binary > smart_log.raw +------------ ++ +It is probably a bad idea to not redirect stdout when using this mode. + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-delete-ns.1 b/Documentation/nvme-delete-ns.1 index fdf9f7a..7ac1853 100644 --- a/Documentation/nvme-delete-ns.1 +++ b/Documentation/nvme-delete-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 08/05/2024 +.\" Date: 10/31/2024 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "08/05/2024" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "10/31/2024" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-delete-ns.html b/Documentation/nvme-delete-ns.html index 4785dd1..6ee087b 100644 --- a/Documentation/nvme-delete-ns.html +++ b/Documentation/nvme-delete-ns.html @@ -4,7 +4,7 @@ - + nvme-id-ns(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm clear-fw-activate-history <device> [--no-uuid | -n]
+
+
+
+
+
+

DESCRIPTION

+
+

This command is a redirect to the OCP plugin’s clear firmware update history log command. +For detailed usage and options, please refer to the documentation for nvme ocp clear-fw-activate-history.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).

+
+
+
+

OPTIONS

+
+
+
+-n +
+
+--no-uuid +
+
+

+ Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support) +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Clear the firmware update history log for the device: +

    +
    +
    +
    # nvme solidigm clear-fw-activate-history /dev/nvme0
    +
    +
    • +
  • +

    +Clear the firmware update history log for an OCP 1.0 device: +

    +
    +
    +
    # nvme solidigm clear-fw-activate-history /dev/nvme0 --no-uuid
    +
    +
    • +
+
+
+
+

SEE ALSO

+
+

nvme-ocp-clear-fw-activate-history(1)

+
+
+
+

NVME

+
+

Part of the nvme-cli suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-clear-fw-activate-history.txt b/Documentation/nvme-solidigm-clear-fw-activate-history.txt new file mode 100644 index 0000000..ac74728 --- /dev/null +++ b/Documentation/nvme-solidigm-clear-fw-activate-history.txt @@ -0,0 +1,48 @@ +nvme-solidigm-clear-fw-activate-history(1) +========================================== + +NAME +---- +nvme-solidigm-clear-fw-activate-history - Clear firmware update history log + +SYNOPSIS +-------- +[verse] +'nvme solidigm clear-fw-activate-history' [--no-uuid | -n] + +DESCRIPTION +----------- +This command is a redirect to the OCP plugin's clear firmware update history log command. +For detailed usage and options, please refer to the documentation for 'nvme ocp clear-fw-activate-history'. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-n:: +--no-uuid:: + Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support) + +EXAMPLES +-------- +* Clear the firmware update history log for the device: ++ +------------ +# nvme solidigm clear-fw-activate-history /dev/nvme0 +------------ + +* Clear the firmware update history log for an OCP 1.0 device: ++ +------------ +# nvme solidigm clear-fw-activate-history /dev/nvme0 --no-uuid +------------ + +SEE ALSO +-------- +nvme-ocp-clear-fw-activate-history(1) + +NVME +---- +Part of the nvme-cli suite. diff --git a/Documentation/nvme-solidigm-clear-pcie-correctable-errors.1 b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.1 new file mode 100644 index 0000000..8095476 --- /dev/null +++ b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.1 @@ -0,0 +1,96 @@ +'\" t +.\" Title: nvme-solidigm-clear-pcie-correctable-errors +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-CLEA" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-clear-pcie-correctable-errors \- Clear PCIe Correctable Error Counters +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm clear\-pcie\-correctable\-errors\fR [\-\-no\-uuid | \-n] +.fi +.SH "DESCRIPTION" +.sp +This command is a redirect to the OCP plugin\(cqs clear PCIe correctable error counters command\&. For detailed usage and options, please refer to the documentation for \fInvme ocp clear\-pcie\-correctable\-error\-counters\fR\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-n, \-\-no\-uuid +.RS 4 +Do not try to automatically detect UUID index for this command (required for old OCP 1\&.0 support)\&. This option is necessary for devices that do not support OCP 2\&.0 or NVMe 1\&.4\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Clear PCIe Correctable Error Counters for the device: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm clear\-pcie\-correctable\-errors /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Clear PCIe Correctable Error Counters for an OCP 1\&.0 device: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm clear\-pcie\-correctable\-errors /dev/nvme0 \-\-no\-uuid +.fi +.if n \{\ +.RE +.\} +.RE +.SH "SEE ALSO" +.sp +nvme\-ocp\-clear\-pcie\-correctable\-error\-counters(1) +.SH "NVME" +.sp +Part of the nvme\-cli suite\&. diff --git a/Documentation/nvme-solidigm-clear-pcie-correctable-errors.html b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.html new file mode 100644 index 0000000..8c30f7e --- /dev/null +++ b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.html @@ -0,0 +1,832 @@ + + + + + + +nvme-solidigm-clear-pcie-correctable-errors(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm clear-pcie-correctable-errors <device> [--no-uuid | -n]
+
+
+
+
+
+

DESCRIPTION

+
+

This command is a redirect to the OCP plugin’s clear PCIe correctable error counters command. +For detailed usage and options, please refer to the documentation for nvme ocp clear-pcie-correctable-error-counters.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).

+
+
+
+

OPTIONS

+
+
+
+-n +
+
+--no-uuid +
+
+

+ Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support). This option is necessary for devices that do not + support OCP 2.0 or NVMe 1.4. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Clear PCIe Correctable Error Counters for the device: +

    +
    +
    +
    # nvme solidigm clear-pcie-correctable-errors /dev/nvme0
    +
    +
    • +
  • +

    +Clear PCIe Correctable Error Counters for an OCP 1.0 device: +

    +
    +
    +
    # nvme solidigm clear-pcie-correctable-errors /dev/nvme0 --no-uuid
    +
    +
    • +
+
+
+
+

SEE ALSO

+
+

nvme-ocp-clear-pcie-correctable-error-counters(1)

+
+
+
+

NVME

+
+

Part of the nvme-cli suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-clear-pcie-correctable-errors.txt b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.txt new file mode 100644 index 0000000..3f5883d --- /dev/null +++ b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.txt @@ -0,0 +1,49 @@ +nvme-solidigm-clear-pcie-correctable-errors(1) +============================================== + +NAME +---- +nvme-solidigm-clear-pcie-correctable-errors - Clear PCIe Correctable Error Counters + +SYNOPSIS +-------- +[verse] +'nvme solidigm clear-pcie-correctable-errors' [--no-uuid | -n] + +DESCRIPTION +----------- +This command is a redirect to the OCP plugin's clear PCIe correctable error counters command. +For detailed usage and options, please refer to the documentation for 'nvme ocp clear-pcie-correctable-error-counters'. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-n:: +--no-uuid:: + Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support). This option is necessary for devices that do not + support OCP 2.0 or NVMe 1.4. + +EXAMPLES +-------- +* Clear PCIe Correctable Error Counters for the device: ++ +------------ +# nvme solidigm clear-pcie-correctable-errors /dev/nvme0 +------------ + +* Clear PCIe Correctable Error Counters for an OCP 1.0 device: ++ +------------ +# nvme solidigm clear-pcie-correctable-errors /dev/nvme0 --no-uuid +------------ + +SEE ALSO +-------- +nvme-ocp-clear-pcie-correctable-error-counters(1) + +NVME +---- +Part of the nvme-cli suite. diff --git a/Documentation/nvme-solidigm-cloud-SSDplugin-version.1 b/Documentation/nvme-solidigm-cloud-SSDplugin-version.1 new file mode 100644 index 0000000..2c4ee66 --- /dev/null +++ b/Documentation/nvme-solidigm-cloud-SSDplugin-version.1 @@ -0,0 +1,64 @@ +'\" t +.\" Title: nvme-solidigm-cloud-SSDplugin-version +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-CLOU" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-cloud-SSDplugin-version \- Prints plug\-in OCP version +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm cloud\-SSDplugin\-version\fR +.fi +.SH "DESCRIPTION" +.sp +Displays the OCP (Open Compute Project) version of the Solidigm cloud SSD plugin\&. +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Display the OCP plugin version: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm cloud\-SSDplugin\-version +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-cloud-SSDplugin-version.html b/Documentation/nvme-solidigm-cloud-SSDplugin-version.html new file mode 100644 index 0000000..eef281a --- /dev/null +++ b/Documentation/nvme-solidigm-cloud-SSDplugin-version.html @@ -0,0 +1,794 @@ + + + + + + +nvme-solidigm-cloud-SSDplugin-version(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm cloud-SSDplugin-version
+
+
+
+
+
+

DESCRIPTION

+
+

Displays the OCP (Open Compute Project) version of the Solidigm cloud SSD plugin.

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Display the OCP plugin version: +

    +
    +
    +
    # nvme solidigm cloud-SSDplugin-version
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-cloud-SSDplugin-version.txt b/Documentation/nvme-solidigm-cloud-SSDplugin-version.txt new file mode 100644 index 0000000..5d17e47 --- /dev/null +++ b/Documentation/nvme-solidigm-cloud-SSDplugin-version.txt @@ -0,0 +1,29 @@ +nvme-solidigm-cloud-SSDplugin-version(1) +======================================== + +NAME +---- +nvme-solidigm-cloud-SSDplugin-version - Prints plug-in OCP version + +SYNOPSIS +-------- +[verse] +'nvme solidigm cloud-SSDplugin-version' + +DESCRIPTION +----------- +Displays the OCP (Open Compute Project) version of the Solidigm cloud SSD plugin. + +EXAMPLES +-------- +* Display the OCP plugin version: ++ +------------ +# nvme solidigm cloud-SSDplugin-version +------------ + +NVME +---- +Part of the nvme-user suite + + diff --git a/Documentation/nvme-solidigm-garbage-collect-log.1 b/Documentation/nvme-solidigm-garbage-collect-log.1 new file mode 100644 index 0000000..637bf96 --- /dev/null +++ b/Documentation/nvme-solidigm-garbage-collect-log.1 @@ -0,0 +1,96 @@ +'\" t +.\" Title: nvme-solidigm-garbage-collect-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-GARB" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-garbage-collect-log \- Retrieve Garbage Collection Log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm garbage\-collect\-log\fR [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves and displays the Solidigm vendor\-specific garbage collection log for the given NVMe device\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and display the garbage collection log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm garbage\-collect\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the garbage collection log in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm garbage\-collect\-log /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-garbage-collect-log.html b/Documentation/nvme-solidigm-garbage-collect-log.html new file mode 100644 index 0000000..7c2ae05 --- /dev/null +++ b/Documentation/nvme-solidigm-garbage-collect-log.html @@ -0,0 +1,825 @@ + + + + + + +nvme-solidigm-garbage-collect-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm garbage-collect-log <device> [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves and displays the Solidigm vendor-specific garbage collection log +for the given NVMe device.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+
+
+

OPTIONS

+
+
+
+-o <fmt> +
+
+--output-format=<fmt> +
+
+

+ Set the reporting format to normal, json, or binary. Only one + output format can be used at a time. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and display the garbage collection log: +

    +
    +
    +
    # nvme solidigm garbage-collect-log /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve the garbage collection log in JSON format: +

    +
    +
    +
    # nvme solidigm garbage-collect-log /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-garbage-collect-log.txt b/Documentation/nvme-solidigm-garbage-collect-log.txt new file mode 100644 index 0000000..77e1be3 --- /dev/null +++ b/Documentation/nvme-solidigm-garbage-collect-log.txt @@ -0,0 +1,44 @@ +nvme-solidigm-garbage-collect-log(1) +==================================== + +NAME +---- +nvme-solidigm-garbage-collect-log - Retrieve Garbage Collection Log + +SYNOPSIS +-------- +[verse] +'nvme solidigm garbage-collect-log' [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves and displays the Solidigm vendor-specific garbage collection log +for the given NVMe device. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or 'binary'. Only one + output format can be used at a time. + +EXAMPLES +-------- +* Retrieve and display the garbage collection log: ++ +------------ +# nvme solidigm garbage-collect-log /dev/nvme0 +------------ + +* Retrieve the garbage collection log in JSON format: ++ +------------ +# nvme solidigm garbage-collect-log /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-id-ctrl.1 b/Documentation/nvme-solidigm-id-ctrl.1 new file mode 100644 index 0000000..f5e9092 --- /dev/null +++ b/Documentation/nvme-solidigm-id-ctrl.1 @@ -0,0 +1,161 @@ +'\" t +.\" Title: nvme-solidigm-id-ctrl +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-ID\-" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-id-ctrl \- Send NVMe Identify Controller, return result and structure +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm id\-ctrl\fR [\-\-raw\-binary | \-b] [\-\-vendor\-specific | \-V] + [\-\-output\-format= | \-o ] [\-\-human\-readable | \-H] + [\-\-verbose | \-v] [\-\-timeout= | \-t ] +.fi +.SH "DESCRIPTION" +.sp +This command is a Solidigm\-specific extension of the NVMe Identify Controller command\&. It sends an NVMe Identify Controller command to the specified device and provides the result and returned structure\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) or a namespace block device (ex: /dev/nvme0n1)\&. +.sp +This command includes all options available in the generic nvme id\-ctrl command, including: \- \-\-raw\-binary or \-b \- \-\-vendor\-specific or \-V \- \-\-output\-format= or \-o \- \-\-human\-readable or \-H \- \-\-verbose or \-v \- \-\-timeout= or \-t +.sp +For detailed usage and options, please refer to the documentation for \fInvme id\-ctrl\fR\&. +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Send the Identify Controller command and interpret the output: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm id\-ctrl /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the raw output to stdout: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm id\-ctrl /dev/nvme0 \-\-raw\-binary +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the output in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm id\-ctrl /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Display the vendor\-specific fields: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm id\-ctrl /dev/nvme0 \-\-vendor\-specific +# nvme solidigm id\-ctrl /dev/nvme0 \-V +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Use human\-readable output: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm id\-ctrl /dev/nvme0 \-\-human\-readable +# nvme solidigm id\-ctrl /dev/nvme0 \-H +.fi +.if n \{\ +.RE +.\} +.RE +.SH "SEE ALSO" +.sp +nvme\-id\-ctrl(1) +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-id-ctrl.html b/Documentation/nvme-solidigm-id-ctrl.html new file mode 100644 index 0000000..b6e657f --- /dev/null +++ b/Documentation/nvme-solidigm-id-ctrl.html @@ -0,0 +1,852 @@ + + + + + + +nvme-solidigm-id-ctrl(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm id-ctrl <device> [--raw-binary | -b] [--vendor-specific | -V]
+                              [--output-format=<fmt> | -o <fmt>] [--human-readable | -H]
+                              [--verbose | -v] [--timeout=<seconds> | -t <seconds>]
+
+
+
+
+
+

DESCRIPTION

+
+

This command is a Solidigm-specific extension of the NVMe Identify Controller command. +It sends an NVMe Identify Controller command to the specified device and provides the result +and returned structure.

+

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) +or a namespace block device (ex: /dev/nvme0n1).

+

This command includes all options available in the generic nvme id-ctrl command, including: +- --raw-binary or -b +- --vendor-specific or -V +- --output-format=<fmt> or -o <fmt> +- --human-readable or -H +- --verbose or -v +- --timeout=<seconds> or -t <seconds>

+

For detailed usage and options, please refer to the documentation for nvme id-ctrl.

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Send the Identify Controller command and interpret the output: +

    +
    +
    +
    # nvme solidigm id-ctrl /dev/nvme0
    +
    +
    • +
  • +

    +Print the raw output to stdout: +

    +
    +
    +
    # nvme solidigm id-ctrl /dev/nvme0 --raw-binary
    +
    +
    • +
  • +

    +Print the output in JSON format: +

    +
    +
    +
    # nvme solidigm id-ctrl /dev/nvme0 -o json
    +
    +
    • +
  • +

    +Display the vendor-specific fields: +

    +
    +
    +
    # nvme solidigm id-ctrl /dev/nvme0 --vendor-specific
+# nvme solidigm id-ctrl /dev/nvme0 -V
    +
    +
    • +
  • +

    +Use human-readable output: +

    +
    +
    +
    # nvme solidigm id-ctrl /dev/nvme0 --human-readable
+# nvme solidigm id-ctrl /dev/nvme0 -H
    +
    +
    • +
+
+
+
+

SEE ALSO

+
+

nvme-id-ctrl(1)

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-id-ctrl.txt b/Documentation/nvme-solidigm-id-ctrl.txt new file mode 100644 index 0000000..7ac67e3 --- /dev/null +++ b/Documentation/nvme-solidigm-id-ctrl.txt @@ -0,0 +1,74 @@ +nvme-solidigm-id-ctrl(1) +======================== + +NAME +---- +nvme-solidigm-id-ctrl - Send NVMe Identify Controller, return result and structure + +SYNOPSIS +-------- +[verse] +'nvme solidigm id-ctrl' [--raw-binary | -b] [--vendor-specific | -V] + [--output-format= | -o ] [--human-readable | -H] + [--verbose | -v] [--timeout= | -t ] + +DESCRIPTION +----------- +This command is a Solidigm-specific extension of the NVMe Identify Controller command. +It sends an NVMe Identify Controller command to the specified device and provides the result +and returned structure. + +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) +or a namespace block device (ex: /dev/nvme0n1). + +This command includes all options available in the generic `nvme id-ctrl` command, including: +- `--raw-binary` or `-b` +- `--vendor-specific` or `-V` +- `--output-format=` or `-o ` +- `--human-readable` or `-H` +- `--verbose` or `-v` +- `--timeout=` or `-t ` + +For detailed usage and options, please refer to the documentation for 'nvme id-ctrl'. + +EXAMPLES +-------- +* Send the Identify Controller command and interpret the output: ++ +------------ +# nvme solidigm id-ctrl /dev/nvme0 +------------ + +* Print the raw output to stdout: ++ +------------ +# nvme solidigm id-ctrl /dev/nvme0 --raw-binary +------------ + +* Print the output in JSON format: ++ +------------ +# nvme solidigm id-ctrl /dev/nvme0 -o json +------------ + +* Display the vendor-specific fields: ++ +------------ +# nvme solidigm id-ctrl /dev/nvme0 --vendor-specific +# nvme solidigm id-ctrl /dev/nvme0 -V +------------ + +* Use human-readable output: ++ +------------ +# nvme solidigm id-ctrl /dev/nvme0 --human-readable +# nvme solidigm id-ctrl /dev/nvme0 -H +------------ + +SEE ALSO +-------- +nvme-id-ctrl(1) + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-latency-tracking-log.1 b/Documentation/nvme-solidigm-latency-tracking-log.1 new file mode 100644 index 0000000..438583b --- /dev/null +++ b/Documentation/nvme-solidigm-latency-tracking-log.1 @@ -0,0 +1,166 @@ +'\" t +.\" Title: nvme-solidigm-latency-tracking-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-LATE" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-latency-tracking-log \- Enable/Retrieve Latency tracking Log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm latency\-tracking\-log\fR [\-\-enable | \-e] [\-\-disable | \-d] + [\-\-read | \-r] [\-\-write | \-w] + [\-\-type | \-t ] + [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Enables, disables, or retrieves the Solidigm latency tracking log for the given NVMe device\&. This log provides detailed information about I/O latencies\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-e, \-\-enable +.RS 4 +Enable latency tracking before retrieving the log\&. +.RE +.PP +\-d, \-\-disable +.RS 4 +Disable latency tracking after retrieving the log\&. +.RE +.PP +\-r, \-\-read +.RS 4 +Retrieve read latency statistics (default if neither \-\-read nor \-\-write is specified)\&. +.RE +.PP +\-w, \-\-write +.RS 4 +Retrieve write latency statistics\&. +.RE +.PP +\-t , \-\-type +.RS 4 +Specify the log type to retrieve\&. Valid values depend on the device\(cqs capabilities\&. +.RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Enable latency tracking and retrieve the read latency log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-enable \-\-read +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the write latency log in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-write \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Disable latency tracking after retrieving the log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-disable +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Specify a log type when retrieving latency statistics: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-type 1 \-\-read +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-latency-tracking-log.html b/Documentation/nvme-solidigm-latency-tracking-log.html new file mode 100644 index 0000000..af52bed --- /dev/null +++ b/Documentation/nvme-solidigm-latency-tracking-log.html @@ -0,0 +1,901 @@ + + + + + + +nvme-solidigm-latency-tracking-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm latency-tracking-log <device> [--enable | -e] [--disable | -d]
+                                              [--read | -r] [--write | -w]
+                                              [--type <value> | -t <value>]
+                                              [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Enables, disables, or retrieves the Solidigm latency tracking log for the +given NVMe device. This log provides detailed information about I/O latencies.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+
+
+

OPTIONS

+
+
+
+-e +
+
+--enable +
+
+

+ Enable latency tracking before retrieving the log. +

+
+
+-d +
+
+--disable +
+
+

+ Disable latency tracking after retrieving the log. +

+
+
+-r +
+
+--read +
+
+

+ Retrieve read latency statistics (default if neither --read nor --write is specified). +

+
+
+-w +
+
+--write +
+
+

+ Retrieve write latency statistics. +

+
+
+-t <value> +
+
+--type <value> +
+
+

+ Specify the log type to retrieve. Valid values depend on the device’s capabilities. +

+
+
+-o <fmt> +
+
+--output-format=<fmt> +
+
+

+ Set the reporting format to normal, json, or binary. Only one + output format can be used at a time. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Enable latency tracking and retrieve the read latency log: +

    +
    +
    +
    # nvme solidigm latency-tracking-log /dev/nvme0 --enable --read
    +
    +
    • +
  • +

    +Retrieve the write latency log in JSON format: +

    +
    +
    +
    # nvme solidigm latency-tracking-log /dev/nvme0 --write -o json
    +
    +
    • +
  • +

    +Disable latency tracking after retrieving the log: +

    +
    +
    +
    # nvme solidigm latency-tracking-log /dev/nvme0 --disable
    +
    +
    • +
  • +

    +Specify a log type when retrieving latency statistics: +

    +
    +
    +
    # nvme solidigm latency-tracking-log /dev/nvme0 --type 1 --read
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-latency-tracking-log.txt b/Documentation/nvme-solidigm-latency-tracking-log.txt new file mode 100644 index 0000000..91940dc --- /dev/null +++ b/Documentation/nvme-solidigm-latency-tracking-log.txt @@ -0,0 +1,79 @@ +nvme-solidigm-latency-tracking-log(1) +===================================== + +NAME +---- +nvme-solidigm-latency-tracking-log - Enable/Retrieve Latency tracking Log + +SYNOPSIS +-------- +[verse] +'nvme solidigm latency-tracking-log' [--enable | -e] [--disable | -d] + [--read | -r] [--write | -w] + [--type | -t ] + [--output-format= | -o ] + +DESCRIPTION +----------- +Enables, disables, or retrieves the Solidigm latency tracking log for the +given NVMe device. This log provides detailed information about I/O latencies. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-e:: +--enable:: + Enable latency tracking before retrieving the log. + +-d:: +--disable:: + Disable latency tracking after retrieving the log. + +-r:: +--read:: + Retrieve read latency statistics (default if neither --read nor --write is specified). + +-w:: +--write:: + Retrieve write latency statistics. + +-t :: +--type :: + Specify the log type to retrieve. Valid values depend on the device's capabilities. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or 'binary'. Only one + output format can be used at a time. + +EXAMPLES +-------- +* Enable latency tracking and retrieve the read latency log: ++ +------------ +# nvme solidigm latency-tracking-log /dev/nvme0 --enable --read +------------ + +* Retrieve the write latency log in JSON format: ++ +------------ +# nvme solidigm latency-tracking-log /dev/nvme0 --write -o json +------------ + +* Disable latency tracking after retrieving the log: ++ +------------ +# nvme solidigm latency-tracking-log /dev/nvme0 --disable +------------ + +* Specify a log type when retrieving latency statistics: ++ +------------ +# nvme solidigm latency-tracking-log /dev/nvme0 --type 1 --read +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-log-page-directory.1 b/Documentation/nvme-solidigm-log-page-directory.1 new file mode 100644 index 0000000..9ae03b4 --- /dev/null +++ b/Documentation/nvme-solidigm-log-page-directory.1 @@ -0,0 +1,96 @@ +'\" t +.\" Title: nvme-solidigm-log-page-directory +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-LOG\" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-log-page-directory \- Retrieve log page directory +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm log\-page\-directory\fR [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves and displays the log page directory for the given Solidigm NVMe device\&. This command provides information about the available log pages and their characteristics\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR +or +\fIjson\fR\&. Only one output format can be used at a time\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and display the log page directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm log\-page\-directory /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the log page directory in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm log\-page\-directory /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-log-page-directory.html b/Documentation/nvme-solidigm-log-page-directory.html new file mode 100644 index 0000000..e6e7b18 --- /dev/null +++ b/Documentation/nvme-solidigm-log-page-directory.html @@ -0,0 +1,825 @@ + + + + + + +nvme-solidigm-log-page-directory(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm log-page-directory <device> [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves and displays the log page directory for the given Solidigm NVMe device. +This command provides information about the available log pages and their +characteristics.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+
+
+

OPTIONS

+
+
+
+-o <fmt> +
+
+--output-format=<fmt> +
+
+

+ Set the reporting format to normal or json. Only one output format can be used at a time. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and display the log page directory: +

    +
    +
    +
    # nvme solidigm log-page-directory /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve the log page directory in JSON format: +

    +
    +
    +
    # nvme solidigm log-page-directory /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-log-page-directory.txt b/Documentation/nvme-solidigm-log-page-directory.txt new file mode 100644 index 0000000..8a8b175 --- /dev/null +++ b/Documentation/nvme-solidigm-log-page-directory.txt @@ -0,0 +1,44 @@ +nvme-solidigm-log-page-directory(1) +=================================== + +NAME +---- +nvme-solidigm-log-page-directory - Retrieve log page directory + +SYNOPSIS +-------- +[verse] +'nvme solidigm log-page-directory' [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves and displays the log page directory for the given Solidigm NVMe device. +This command provides information about the available log pages and their +characteristics. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal' or 'json'. Only one output format can be used at a time. + +EXAMPLES +-------- +* Retrieve and display the log page directory: ++ +------------ +# nvme solidigm log-page-directory /dev/nvme0 +------------ + +* Retrieve the log page directory in JSON format: ++ +------------ +# nvme solidigm log-page-directory /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-market-log.1 b/Documentation/nvme-solidigm-market-log.1 new file mode 100644 index 0000000..9a70b25 --- /dev/null +++ b/Documentation/nvme-solidigm-market-log.1 @@ -0,0 +1,93 @@ +'\" t +.\" Title: nvme-solidigm-market-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-MARK" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-market-log \- Retrieve Market Log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm market\-log\fR [\-\-raw\-binary | \-b] +.fi +.SH "DESCRIPTION" +.sp +Retrieves and displays the Solidigm Marketing Name log for the given NVMe device\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-b, \-\-raw\-binary +.RS 4 +Output the raw log data in binary format\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and display the marketing name log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm market\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the raw binary data of the marketing name log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm market\-log /dev/nvme0 \-\-raw\-binary +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-market-log.html b/Documentation/nvme-solidigm-market-log.html new file mode 100644 index 0000000..d9d315e --- /dev/null +++ b/Documentation/nvme-solidigm-market-log.html @@ -0,0 +1,823 @@ + + + + + + +nvme-solidigm-market-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm market-log <device> [--raw-binary | -b]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves and displays the Solidigm Marketing Name log for the given NVMe device.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+
+
+

OPTIONS

+
+
+
+-b +
+
+--raw-binary +
+
+

+ Output the raw log data in binary format. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and display the marketing name log: +

    +
    +
    +
    # nvme solidigm market-log /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve the raw binary data of the marketing name log: +

    +
    +
    +
    # nvme solidigm market-log /dev/nvme0 --raw-binary
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-market-log.txt b/Documentation/nvme-solidigm-market-log.txt new file mode 100644 index 0000000..1b5e268 --- /dev/null +++ b/Documentation/nvme-solidigm-market-log.txt @@ -0,0 +1,42 @@ +nvme-solidigm-market-log(1) +=========================== + +NAME +---- +nvme-solidigm-market-log - Retrieve Market Log + +SYNOPSIS +-------- +[verse] +'nvme solidigm market-log' [--raw-binary | -b] + +DESCRIPTION +----------- +Retrieves and displays the Solidigm Marketing Name log for the given NVMe device. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-b:: +--raw-binary:: + Output the raw log data in binary format. + +EXAMPLES +-------- +* Retrieve and display the marketing name log: ++ +------------ +# nvme solidigm market-log /dev/nvme0 +------------ + +* Retrieve the raw binary data of the marketing name log: ++ +------------ +# nvme solidigm market-log /dev/nvme0 --raw-binary +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-parse-telemetry-log.1 b/Documentation/nvme-solidigm-parse-telemetry-log.1 new file mode 100644 index 0000000..9764fdf --- /dev/null +++ b/Documentation/nvme-solidigm-parse-telemetry-log.1 @@ -0,0 +1,183 @@ +'\" t +.\" Title: nvme-solidigm-parse-telemetry-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-PARS" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-parse-telemetry-log \- Parse and display Solidigm Telemetry log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm parse\-telemetry\-log\fR [OPTIONS] +.fi +.SH "DESCRIPTION" +.sp +Retrieves, parses, and displays the Telemetry log for the given Solidigm NVMe device\&. This command provides detailed information about the device\(cqs telemetry data, which can be useful for diagnostics and performance analysis\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-g , \-\-host\-generate= +.RS 4 +Controls when to generate a new host\-initiated report\&. Default value +\fI1\fR +generates a new host\-initiated report, value +\fI0\fR +causes retrieval of an existing log\&. Valid values are 0 and 1\&. +.RE +.PP +\-c, \-\-controller\-init +.RS 4 +Gather report generated by the controller\&. +.RE +.PP +\-d , \-\-data\-area= +.RS 4 +Pick which telemetry data area to report\&. Default is 3 to fetch areas 1\-3\&. Valid options are 1, 2, 3, 4\&. +.RE +.PP +\-j , \-\-config\-file= +.RS 4 +Specify a JSON configuration file for custom parsing of the telemetry log\&. +.RE +.PP +\-s, \-\-source\-file +.RS 4 +Indicates that the argument is a binary file containing a log dump instead of a block or character device\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and parse the telemetry log with default options: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm parse\-telemetry\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve an existing telemetry log without generating a new one: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm parse\-telemetry\-log /dev/nvme0 \-g 0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Parse a specific data area of the telemetry log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm parse\-telemetry\-log /dev/nvme0 \-d 2 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Use a custom configuration file for parsing: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm parse\-telemetry\-log /dev/nvme0 \-j config\&.json +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Parse a telemetry log from a binary file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm parse\-telemetry\-log telemetry_dump\&.bin \-s +.fi +.if n \{\ +.RE +.\} +.RE +.SH "OUTPUT" +.sp +The command outputs the parsed telemetry log in JSON format to stdout\&. +.SH "NVME" +.sp +Part of the nvme\-cli suite diff --git a/Documentation/nvme-solidigm-parse-telemetry-log.html b/Documentation/nvme-solidigm-parse-telemetry-log.html new file mode 100644 index 0000000..d33d709 --- /dev/null +++ b/Documentation/nvme-solidigm-parse-telemetry-log.html @@ -0,0 +1,906 @@ + + + + + + +nvme-solidigm-parse-telemetry-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm parse-telemetry-log <device> [OPTIONS]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves, parses, and displays the Telemetry log for the given Solidigm NVMe device. +This command provides detailed information about the device’s telemetry data, which +can be useful for diagnostics and performance analysis.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+
+
+

OPTIONS

+
+
+
+-g <num> +
+
+--host-generate=<num> +
+
+

+ Controls when to generate a new host-initiated report. Default value 1 generates + a new host-initiated report, value 0 causes retrieval of an existing log. + Valid values are 0 and 1. +

+
+
+-c +
+
+--controller-init +
+
+

+ Gather report generated by the controller. +

+
+
+-d <num> +
+
+--data-area=<num> +
+
+

+ Pick which telemetry data area to report. Default is 3 to fetch areas 1-3. + Valid options are 1, 2, 3, 4. +

+
+
+-j <file> +
+
+--config-file=<file> +
+
+

+ Specify a JSON configuration file for custom parsing of the telemetry log. +

+
+
+-s +
+
+--source-file +
+
+

+ Indicates that the <device> argument is a binary file containing a log dump + instead of a block or character device. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and parse the telemetry log with default options: +

    +
    +
    +
    # nvme solidigm parse-telemetry-log /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve an existing telemetry log without generating a new one: +

    +
    +
    +
    # nvme solidigm parse-telemetry-log /dev/nvme0 -g 0
    +
    +
    • +
  • +

    +Parse a specific data area of the telemetry log: +

    +
    +
    +
    # nvme solidigm parse-telemetry-log /dev/nvme0 -d 2
    +
    +
    • +
  • +

    +Use a custom configuration file for parsing: +

    +
    +
    +
    # nvme solidigm parse-telemetry-log /dev/nvme0 -j config.json
    +
    +
    • +
  • +

    +Parse a telemetry log from a binary file: +

    +
    +
    +
    # nvme solidigm parse-telemetry-log telemetry_dump.bin -s
    +
    +
    • +
+
+
+
+

OUTPUT

+
+

The command outputs the parsed telemetry log in JSON format to stdout.

+
+
+
+

NVME

+
+

Part of the nvme-cli suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-parse-telemetry-log.txt b/Documentation/nvme-solidigm-parse-telemetry-log.txt new file mode 100644 index 0000000..38a678b --- /dev/null +++ b/Documentation/nvme-solidigm-parse-telemetry-log.txt @@ -0,0 +1,86 @@ +nvme-solidigm-parse-telemetry-log(1) +==================================== + +NAME +---- +nvme-solidigm-parse-telemetry-log - Parse and display Solidigm Telemetry log + +SYNOPSIS +-------- +[verse] +'nvme solidigm parse-telemetry-log' [OPTIONS] + +DESCRIPTION +----------- +Retrieves, parses, and displays the Telemetry log for the given Solidigm NVMe device. +This command provides detailed information about the device's telemetry data, which +can be useful for diagnostics and performance analysis. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-g :: +--host-generate=:: + Controls when to generate a new host-initiated report. Default value '1' generates + a new host-initiated report, value '0' causes retrieval of an existing log. + Valid values are 0 and 1. + +-c:: +--controller-init:: + Gather report generated by the controller. + +-d :: +--data-area=:: + Pick which telemetry data area to report. Default is 3 to fetch areas 1-3. + Valid options are 1, 2, 3, 4. + +-j :: +--config-file=:: + Specify a JSON configuration file for custom parsing of the telemetry log. + +-s:: +--source-file:: + Indicates that the argument is a binary file containing a log dump + instead of a block or character device. + +EXAMPLES +-------- +* Retrieve and parse the telemetry log with default options: ++ +------------ +# nvme solidigm parse-telemetry-log /dev/nvme0 +------------ + +* Retrieve an existing telemetry log without generating a new one: ++ +------------ +# nvme solidigm parse-telemetry-log /dev/nvme0 -g 0 +------------ + +* Parse a specific data area of the telemetry log: ++ +------------ +# nvme solidigm parse-telemetry-log /dev/nvme0 -d 2 +------------ + +* Use a custom configuration file for parsing: ++ +------------ +# nvme solidigm parse-telemetry-log /dev/nvme0 -j config.json +------------ + +* Parse a telemetry log from a binary file: ++ +------------ +# nvme solidigm parse-telemetry-log telemetry_dump.bin -s +------------ + +OUTPUT +------ +The command outputs the parsed telemetry log in JSON format to stdout. + +NVME +---- +Part of the nvme-cli suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-smart-log-add.1 b/Documentation/nvme-solidigm-smart-log-add.1 new file mode 100644 index 0000000..a71787b --- /dev/null +++ b/Documentation/nvme-solidigm-smart-log-add.1 @@ -0,0 +1,123 @@ +'\" t +.\" Title: nvme-solidigm-smart-log-add +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-SMAR" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-smart-log-add \- Retrieve Solidigm SMART Log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm smart\-log\-add\fR [\-\-namespace\-id= | \-n ] + [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves the Solidigm vendor\-specific SMART log for the given NVMe device and optionally the specified namespace, then displays the log\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Retrieve the log for the given nsid\&. If not specified, the log will be retrieved for all namespaces\&. +.RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the Solidigm SMART log for all namespaces: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm smart\-log\-add /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the Solidigm SMART log for namespace 1: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm smart\-log\-add /dev/nvme0 \-n 1 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the Solidigm SMART log in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm smart\-log\-add /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-smart-log-add.html b/Documentation/nvme-solidigm-smart-log-add.html new file mode 100644 index 0000000..178f6bf --- /dev/null +++ b/Documentation/nvme-solidigm-smart-log-add.html @@ -0,0 +1,847 @@ + + + + + + +nvme-solidigm-smart-log-add(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm smart-log-add <device> [--namespace-id=<nsid> | -n <nsid>]
+                                       [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the Solidigm vendor-specific SMART log for the given NVMe device +and optionally the specified namespace, then displays the log.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+
+
+

OPTIONS

+
+
+
+-n <nsid> +
+
+--namespace-id=<nsid> +
+
+

+ Retrieve the log for the given nsid. If not specified, the log + will be retrieved for all namespaces. +

+
+
+-o <fmt> +
+
+--output-format=<fmt> +
+
+

+ Set the reporting format to normal, json, or binary. Only one + output format can be used at a time. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve the Solidigm SMART log for all namespaces: +

    +
    +
    +
    # nvme solidigm smart-log-add /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve the Solidigm SMART log for namespace 1: +

    +
    +
    +
    # nvme solidigm smart-log-add /dev/nvme0 -n 1
    +
    +
    • +
  • +

    +Retrieve the Solidigm SMART log in JSON format: +

    +
    +
    +
    # nvme solidigm smart-log-add /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-smart-log-add.txt b/Documentation/nvme-solidigm-smart-log-add.txt new file mode 100644 index 0000000..5a9b92c --- /dev/null +++ b/Documentation/nvme-solidigm-smart-log-add.txt @@ -0,0 +1,56 @@ +nvme-solidigm-smart-log-add(1) +============================== + +NAME +---- +nvme-solidigm-smart-log-add - Retrieve Solidigm SMART Log + +SYNOPSIS +-------- +[verse] +'nvme solidigm smart-log-add' [--namespace-id= | -n ] + [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves the Solidigm vendor-specific SMART log for the given NVMe device +and optionally the specified namespace, then displays the log. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-n :: +--namespace-id=:: + Retrieve the log for the given nsid. If not specified, the log + will be retrieved for all namespaces. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or 'binary'. Only one + output format can be used at a time. + +EXAMPLES +-------- +* Retrieve the Solidigm SMART log for all namespaces: ++ +------------ +# nvme solidigm smart-log-add /dev/nvme0 +------------ + +* Retrieve the Solidigm SMART log for namespace 1: ++ +------------ +# nvme solidigm smart-log-add /dev/nvme0 -n 1 +------------ + +* Retrieve the Solidigm SMART log in JSON format: ++ +------------ +# nvme solidigm smart-log-add /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-temp-stats.1 b/Documentation/nvme-solidigm-temp-stats.1 new file mode 100644 index 0000000..50e5b44 --- /dev/null +++ b/Documentation/nvme-solidigm-temp-stats.1 @@ -0,0 +1,93 @@ +'\" t +.\" Title: nvme-solidigm-temp-stats +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-TEMP" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-temp-stats \- Retrieve Temperature Statistics log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm temp\-stats\fR [\-\-raw\-binary | \-b] +.fi +.SH "DESCRIPTION" +.sp +Retrieves and displays the Temperature Statistics log for the given Solidigm NVMe device\&. This log provides detailed temperature\-related information\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-b, \-\-raw\-binary +.RS 4 +Dump output in binary format\&. This option will display the raw data instead of interpreting it\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and display the temperature statistics log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm temp\-stats /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the temperature statistics log in raw binary format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm temp\-stats /dev/nvme0 \-\-raw\-binary +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-temp-stats.html b/Documentation/nvme-solidigm-temp-stats.html new file mode 100644 index 0000000..d61c5fc --- /dev/null +++ b/Documentation/nvme-solidigm-temp-stats.html @@ -0,0 +1,825 @@ + + + + + + +nvme-solidigm-temp-stats(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm temp-stats <device> [--raw-binary | -b]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves and displays the Temperature Statistics log for the given Solidigm +NVMe device. This log provides detailed temperature-related information.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+
+
+

OPTIONS

+
+
+
+-b +
+
+--raw-binary +
+
+

+ Dump output in binary format. This option will display the raw data + instead of interpreting it. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and display the temperature statistics log: +

    +
    +
    +
    # nvme solidigm temp-stats /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve the temperature statistics log in raw binary format: +

    +
    +
    +
    # nvme solidigm temp-stats /dev/nvme0 --raw-binary
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-temp-stats.txt b/Documentation/nvme-solidigm-temp-stats.txt new file mode 100644 index 0000000..f672382 --- /dev/null +++ b/Documentation/nvme-solidigm-temp-stats.txt @@ -0,0 +1,44 @@ +nvme-solidigm-temp-stats(1) +=========================== + +NAME +---- +nvme-solidigm-temp-stats - Retrieve Temperature Statistics log + +SYNOPSIS +-------- +[verse] +'nvme solidigm temp-stats' [--raw-binary | -b] + +DESCRIPTION +----------- +Retrieves and displays the Temperature Statistics log for the given Solidigm +NVMe device. This log provides detailed temperature-related information. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-b:: +--raw-binary:: + Dump output in binary format. This option will display the raw data + instead of interpreting it. + +EXAMPLES +-------- +* Retrieve and display the temperature statistics log: ++ +------------ +# nvme solidigm temp-stats /dev/nvme0 +------------ + +* Retrieve the temperature statistics log in raw binary format: ++ +------------ +# nvme solidigm temp-stats /dev/nvme0 --raw-binary +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-vs-drive-info.1 b/Documentation/nvme-solidigm-vs-drive-info.1 new file mode 100644 index 0000000..cd3b63e --- /dev/null +++ b/Documentation/nvme-solidigm-vs-drive-info.1 @@ -0,0 +1,96 @@ +'\" t +.\" Title: nvme-solidigm-vs-drive-info +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-VS\-" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-vs-drive-info \- Retrieve drive information +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm vs\-drive\-info\fR [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves and displays vendor\-specific drive information for the given Solidigm NVMe device\&. This command provides additional details about the drive that may not be available through standard NVMe commands\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR +or +\fIjson\fR\&. Only one output format can be used at a time\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and display the drive information: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-drive\-info /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the drive information in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-drive\-info /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-vs-drive-info.html b/Documentation/nvme-solidigm-vs-drive-info.html new file mode 100644 index 0000000..04b0c74 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-drive-info.html @@ -0,0 +1,826 @@ + + + + + + +nvme-solidigm-vs-drive-info(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm vs-drive-info <device> [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves and displays vendor-specific drive information for the given Solidigm +NVMe device. This command provides additional details about the drive that may +not be available through standard NVMe commands.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+
+
+

OPTIONS

+
+
+
+-o <fmt> +
+
+--output-format=<fmt> +
+
+

+ Set the reporting format to normal or json. Only one output format + can be used at a time. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and display the drive information: +

    +
    +
    +
    # nvme solidigm vs-drive-info /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve the drive information in JSON format: +

    +
    +
    +
    # nvme solidigm vs-drive-info /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-vs-drive-info.txt b/Documentation/nvme-solidigm-vs-drive-info.txt new file mode 100644 index 0000000..8096b13 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-drive-info.txt @@ -0,0 +1,45 @@ +nvme-solidigm-vs-drive-info(1) +============================== + +NAME +---- +nvme-solidigm-vs-drive-info - Retrieve drive information + +SYNOPSIS +-------- +[verse] +'nvme solidigm vs-drive-info' [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves and displays vendor-specific drive information for the given Solidigm +NVMe device. This command provides additional details about the drive that may +not be available through standard NVMe commands. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal' or 'json'. Only one output format + can be used at a time. + +EXAMPLES +-------- +* Retrieve and display the drive information: ++ +------------ +# nvme solidigm vs-drive-info /dev/nvme0 +------------ + +* Retrieve the drive information in JSON format: ++ +------------ +# nvme solidigm vs-drive-info /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-vs-fw-activate-history.1 b/Documentation/nvme-solidigm-vs-fw-activate-history.1 new file mode 100644 index 0000000..b1d2e99 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-fw-activate-history.1 @@ -0,0 +1,94 @@ +'\" t +.\" Title: nvme-solidigm-vs-fw-activate-history +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-VS\-" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-vs-fw-activate-history \- Get firmware activation history log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm vs\-fw\-activate\-history\fR [OPTIONS] +.fi +.SH "DESCRIPTION" +.sp +This command retrieves the firmware activation history log for Solidigm NVMe devices\&. It redirects to the OCP plug\-in for compatibility\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR +or +\fIjson\fR\&. Only one output format can be used at a time\&. Default is normal\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the firmware activation history log in normal format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-fw\-activate\-history /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the firmware activation history log in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-fw\-activate\-history /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-cli suite diff --git a/Documentation/nvme-solidigm-vs-fw-activate-history.html b/Documentation/nvme-solidigm-vs-fw-activate-history.html new file mode 100644 index 0000000..75a6c87 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-fw-activate-history.html @@ -0,0 +1,821 @@ + + + + + + +nvme-solidigm-vs-fw-activate-history(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm vs-fw-activate-history <device> [OPTIONS]
+
+
+
+
+
+

DESCRIPTION

+
+

This command retrieves the firmware activation history log for Solidigm NVMe devices. It redirects to the OCP plug-in for compatibility.

+
+
+
+

OPTIONS

+
+
+
+-o <fmt> +
+
+--output-format=<fmt> +
+
+

+ Set the reporting format to normal or json. Only one output format can be used at a time. Default is normal. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Print the firmware activation history log in normal format: +

    +
    +
    +
    # nvme solidigm vs-fw-activate-history /dev/nvme0
    +
    +
    • +
  • +

    +Print the firmware activation history log in JSON format: +

    +
    +
    +
    # nvme solidigm vs-fw-activate-history /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-cli suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-vs-fw-activate-history.txt b/Documentation/nvme-solidigm-vs-fw-activate-history.txt new file mode 100644 index 0000000..cfe4e86 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-fw-activate-history.txt @@ -0,0 +1,39 @@ +nvme-solidigm-vs-fw-activate-history(1) +======================================= + +NAME +---- +nvme-solidigm-vs-fw-activate-history - Get firmware activation history log + +SYNOPSIS +-------- +[verse] +'nvme solidigm vs-fw-activate-history' [OPTIONS] + +DESCRIPTION +----------- +This command retrieves the firmware activation history log for Solidigm NVMe devices. It redirects to the OCP plug-in for compatibility. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal' or 'json'. Only one output format can be used at a time. Default is normal. + +EXAMPLES +-------- +* Print the firmware activation history log in normal format: ++ +------------ +# nvme solidigm vs-fw-activate-history /dev/nvme0 +------------ + +* Print the firmware activation history log in JSON format: ++ +------------ +# nvme solidigm vs-fw-activate-history /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-cli suite diff --git a/Documentation/nvme-solidigm-vs-internal-log.1 b/Documentation/nvme-solidigm-vs-internal-log.1 new file mode 100644 index 0000000..c30a350 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-internal-log.1 @@ -0,0 +1,126 @@ +'\" t +.\" Title: nvme-solidigm-vs-internal-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-VS\-" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-vs-internal-log \- Retrieve Debug log binaries +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm vs\-internal\-log\fR [\-\-log\-type= | \-t ] + [\-\-output\-dir= | \-d ] + [\-\-verbose | \-v] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, retrieves the Solidigm vendor\-specific internal debug log binaries and saves them to the specified output directory\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-t , \-\-log\-type= +.RS 4 +Specify the type of log to retrieve\&. Valid options are ALL, CIT, HIT, NLOG, ASSERT, and EVENT\&. Defaults to ALL\&. +.RE +.PP +\-d , \-\-output\-dir= +.RS 4 +Specify the output directory for the log files\&. Defaults to the current working directory\&. +.RE +.PP +\-v, \-\-verbose +.RS 4 +Enable verbose output for additional information during the log retrieval process\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve all internal logs and save them to the current directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-internal\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve a specific log type and save it to a custom directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-internal\-log /dev/nvme0 \-t NLOG \-d /tmp/logs +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve logs with verbose output: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-internal\-log /dev/nvme0 \-v +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-vs-internal-log.html b/Documentation/nvme-solidigm-vs-internal-log.html new file mode 100644 index 0000000..2ab4fab --- /dev/null +++ b/Documentation/nvme-solidigm-vs-internal-log.html @@ -0,0 +1,857 @@ + + + + + + +nvme-solidigm-vs-internal-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm vs-internal-log <device> [--log-type=<type> | -t <type>]
+                                          [--output-dir=<dir> | -d <dir>]
+                                          [--verbose | -v]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, retrieves the Solidigm vendor-specific internal +debug log binaries and saves them to the specified output directory.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+
+
+

OPTIONS

+
+
+
+-t <type> +
+
+--log-type=<type> +
+
+

+ Specify the type of log to retrieve. Valid options are ALL, CIT, HIT, NLOG, ASSERT, and EVENT. Defaults to ALL. +

+
+
+-d <dir> +
+
+--output-dir=<dir> +
+
+

+ Specify the output directory for the log files. Defaults to the current working directory. +

+
+
+-v +
+
+--verbose +
+
+

+ Enable verbose output for additional information during the log retrieval process. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve all internal logs and save them to the current directory: +

    +
    +
    +
    # nvme solidigm vs-internal-log /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve a specific log type and save it to a custom directory: +

    +
    +
    +
    # nvme solidigm vs-internal-log /dev/nvme0 -t NLOG -d /tmp/logs
    +
    +
    • +
  • +

    +Retrieve logs with verbose output: +

    +
    +
    +
    # nvme solidigm vs-internal-log /dev/nvme0 -v
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-vs-internal-log.txt b/Documentation/nvme-solidigm-vs-internal-log.txt new file mode 100644 index 0000000..e488106 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-internal-log.txt @@ -0,0 +1,59 @@ +nvme-solidigm-vs-internal-log(1) +================================ + +NAME +---- +nvme-solidigm-vs-internal-log - Retrieve Debug log binaries + +SYNOPSIS +-------- +[verse] +'nvme solidigm vs-internal-log' [--log-type= | -t ] + [--output-dir= | -d ] + [--verbose | -v] + +DESCRIPTION +----------- +For the NVMe device given, retrieves the Solidigm vendor-specific internal +debug log binaries and saves them to the specified output directory. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-t :: +--log-type=:: + Specify the type of log to retrieve. Valid options are ALL, CIT, HIT, NLOG, ASSERT, and EVENT. Defaults to ALL. + +-d :: +--output-dir=:: + Specify the output directory for the log files. Defaults to the current working directory. + +-v:: +--verbose:: + Enable verbose output for additional information during the log retrieval process. + +EXAMPLES +-------- +* Retrieve all internal logs and save them to the current directory: ++ +------------ +# nvme solidigm vs-internal-log /dev/nvme0 +------------ + +* Retrieve a specific log type and save it to a custom directory: ++ +------------ +# nvme solidigm vs-internal-log /dev/nvme0 -t NLOG -d /tmp/logs +------------ + +* Retrieve logs with verbose output: ++ +------------ +# nvme solidigm vs-internal-log /dev/nvme0 -v +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-vs-smart-add-log.1 b/Documentation/nvme-solidigm-vs-smart-add-log.1 new file mode 100644 index 0000000..80f2bb5 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-smart-add-log.1 @@ -0,0 +1,94 @@ +'\" t +.\" Title: nvme-solidigm-vs-smart-add-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-VS\-" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-vs-smart-add-log \- Get SMART / health extended log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm vs\-smart\-add\-log\fR [OPTIONS] +.fi +.SH "DESCRIPTION" +.sp +This command retrieves the SMART / health extended log for Solidigm NVMe devices\&. It redirects to the OCP plug\-in for compatibility\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR +or +\fIjson\fR\&. Only one output format can be used at a time\&. Default is normal\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the SMART / health extended log in normal format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-smart\-add\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the SMART / health extended log in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-smart\-add\-log /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-cli suite diff --git a/Documentation/nvme-solidigm-vs-smart-add-log.html b/Documentation/nvme-solidigm-vs-smart-add-log.html new file mode 100644 index 0000000..24832aa --- /dev/null +++ b/Documentation/nvme-solidigm-vs-smart-add-log.html @@ -0,0 +1,821 @@ + + + + + + +nvme-solidigm-vs-smart-add-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm vs-smart-add-log <device> [OPTIONS]
+
+
+
+
+
+

DESCRIPTION

+
+

This command retrieves the SMART / health extended log for Solidigm NVMe devices. It redirects to the OCP plug-in for compatibility.

+
+
+
+

OPTIONS

+
+
+
+-o <fmt> +
+
+--output-format=<fmt> +
+
+

+ Set the reporting format to normal or json. Only one output format can be used at a time. Default is normal. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Print the SMART / health extended log in normal format: +

    +
    +
    +
    # nvme solidigm vs-smart-add-log /dev/nvme0
    +
    +
    • +
  • +

    +Print the SMART / health extended log in JSON format: +

    +
    +
    +
    # nvme solidigm vs-smart-add-log /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-cli suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-vs-smart-add-log.txt b/Documentation/nvme-solidigm-vs-smart-add-log.txt new file mode 100644 index 0000000..c1bf0c8 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-smart-add-log.txt @@ -0,0 +1,39 @@ +nvme-solidigm-vs-smart-add-log(1) +================================= + +NAME +---- +nvme-solidigm-vs-smart-add-log - Get SMART / health extended log + +SYNOPSIS +-------- +[verse] +'nvme solidigm vs-smart-add-log' [OPTIONS] + +DESCRIPTION +----------- +This command retrieves the SMART / health extended log for Solidigm NVMe devices. It redirects to the OCP plug-in for compatibility. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal' or 'json'. Only one output format can be used at a time. Default is normal. + +EXAMPLES +-------- +* Print the SMART / health extended log in normal format: ++ +------------ +# nvme solidigm vs-smart-add-log /dev/nvme0 +------------ + +* Print the SMART / health extended log in JSON format: ++ +------------ +# nvme solidigm vs-smart-add-log /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-cli suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-workload-tracker.1 b/Documentation/nvme-solidigm-workload-tracker.1 new file mode 100644 index 0000000..444a91d --- /dev/null +++ b/Documentation/nvme-solidigm-workload-tracker.1 @@ -0,0 +1,221 @@ +'\" t +.\" Title: nvme-solidigm-workload-tracker +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-WORK" "1" "10/31/2024" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-solidigm-workload-tracker \- Real\-time capture of Workload Tracker samples +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm workload\-tracker\fR [\-\-enable | \-e] [\-\-disable | \-d] + [\-\-sample\-time=