Retrieve Transcend NVMe device's bad blocks
linknvme:nvme-transcend-healthvalue[1]::
- Use NVMe SMART table to analyse the health value of Transcend device
+ Use NVMe SMART table to analyze the health value of Transcend device
linknvme:nvme-virtium-show-identify[1]::
Show a complete detail of identify device information in json format
Retrieve Smart Log
linknvme:nvme-ana-log[1]::
- Retreive ANA(Asymmetric Namespace Access) Log
+ Retrieve ANA(Asymmetric Namespace Access) Log
linknvme:nvme-endurance-log[1]::
Retrieve endurance Log
NVMe Identify Namespace NVM Command Set for the specified LBA Format index
linknvme:nvme-persistent-event-log[1]::
- Retrieve Presistent Event Log
+ Retrieve Persistent Event Log
linknvme:nvme-predictable-lat-log[1]::
Retrieve Predictable Latency per Nvmset Log
-c <ctrl-list,>::
-controllers=<ctrl-list,>::
The comma separated list of controller identifiers to attach
- the namesapce too.
+ the namespace too.
EXAMPLES
--------
- Attach namspace to the controller:
+ Attach namespace to the controller:
# nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21
-y <metasize>::
--metadata-size=<metasize>::
- Size of metadata to be trasnferred in bytes.
+ Size of metadata to be transferred in bytes.
-r <reftag>::
---ref-tag=<regtag>::
+--ref-tag=<reftag>::
Reference Tag for Protection Information
-d <data-file>::
--dir-type=<type>::
Optional directive type. The nvme-cli only enforces the value
be in the defined range for the directive type, though the NVMe
- specifcation (1.3a) defines only one directive, 01h, for write
- stream idenfiers.
+ specification (1.3a) defines only one directive, 01h, for write
+ stream identifiers.
-S <spec>::
--dir-spec=<spec>::
data protection processing.
--force::
- Ignore namespace is currently busy and perfome the operation
+ Ignore namespace is currently busy and performed the operation
even though.
EXAMPLES
exists, the command will quit with an error.
Otherwise a specific Discovery Controller should be specified using the
---transport, --traddr and if necessary the --trsvcid and a Diѕcovery
+--transport, --traddr and if necessary the --trsvcid and a Discovery
request will be sent to the specified Discovery Controller.
See the documentation for the nvme-discover(1) command for further
-T <type>::
Optional directive type. The nvme-cli only enforces the value
be in the defined range for the directive type, though the NVMe
- specifcation (1.3a) defines only one directive, 01h, for write
- stream idenfiers.
+ specification (1.3a) defines only one directive, 01h, for write
+ stream identifiers.
--dir-spec=<spec>::
-S <spec>::
-a::
--anagrp-id::
- ANA Gorup Identifier. If this value is 0h specifies
+ ANA Group Identifier. If this value is 0h specifies
that the controller determines the value to use
-i <nvmsetid>::
-------
-n <NUM>::
--namespace-id=<NUM>::
- Indicate the namespace in which the device self-test has to becarried out
+ Indicate the namespace in which the device self-test has to be carried out
-s <NUM>::
--self-test-code=<NUM>::
The DIM command is used to explicitly register with Discovery Controllers (DC),
especially with Central Discovery Controllers (CDC). CDCs maintain a database (DB)
-of all the Hosts and Storage Susbsystems in a network. The register task is used
+of all the Hosts and Storage Subsystems in a network. The register task is used
to add a host to the CDC's DB. The deregister task is used to remove a host from
the CDC's DB.
exists, the command will quit with an error.
Otherwise, a specific Discovery Controller should be specified using the
---transport, --traddr, and if necessary the --trsvcid flags. A Diѕcovery
+--transport, --traddr, and if necessary the --trsvcid flags. A Discovery
request will then be sent to the specified Discovery Controller.
BACKGROUND
-k <#>::
--keep-alive-tmo=<#>::
- Overrides the default dealy (in seconds) for keep alive.
+ Overrides the default timeout (in seconds) for keep alive.
This option will be ignored for the discovery, and it is only
implemented for completeness.
'binary'. Only one output format can be used at a time.
--force::
- Disable the built-in persitent discover connection rules.
+ Disable the built-in persistent discover connection rules.
Combined with --persistent flag, always create new
persistent discovery connection.
DESCRIPTION
-----------
For the NVMe device given, sends an FID Support and Effects log and
-provides the result and returned logstructure.
+provides the result and returned log 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).
--bpid=<boot-partid>::
-b <boot-partid>::
- Specifiies the Boot partition that shall be used for the Commit Action,
+ Specifies the Boot partition that shall be used for the Commit Action,
if applicable (default: 0)
EXAMPLES
OPTIONS
-------
-f <firmware-file>::
---fw=<firmeware-file>::
+--fw=<firmware-file>::
Required argument. This specifies the path to the device's
firmware file on your system that will be read by the program
and sent to the device.
DESCRIPTION
-----------
-For the NVMe device given, send an identify command and return the domian list
+For the NVMe device given, send an identify command and return the domain list
data structure.
The <device> parameter is mandatory and may be either the NVMe character
-y <command_set_identifier>::
--csi=<command_set_identifier>::
If this value is given, retrieve the identify list structure associated
- with the speicified I/O command set.
+ with the specified I/O command set.
-a::
--all::
-v::
--verbose::
Increase the information in the output, showing nvme subsystems,
- controllers and namespaces separately and how they're realted to each
+ controllers and namespaces separately and how they're related to each
other.
ENVIRONMENT
-----------
The Lockdown command is used to control the Command and Feature Lockdown
capability which configures the prohibition or allowance of execution of the
-specified commandor Set Features command targeting a specific Feature
+specified command or Set Features command targeting a specific Feature
Identifier.
OPTIONS
--prhbt=<prhbt>::
-p <prhbt>::
- Prohibit(PRHBT) bit specifies whether to prohibit or allow the command
+ Prohibit (PRHBT) bit specifies whether to prohibit or allow the command
opcode or Set Features Feature Identifier specified by this command.
--scp=<scp>::
-s <scp>::
- Scope(SCP) field specifies the contents of the Opcode or Feature Identifier field.
+ Scope (SCP) field specifies the contents of the Opcode or Feature Identifier field.
--uuid=<UUID_Index>::
-U <UUID_Index>::
- UUID Index - If this field is set to a non-zerovalue, then the value of
- this field is the index of a UUID in the UUIDList that is used by the command.
+ UUID Index - If this field is set to a non-zero value, then the value of
+ this field is the index of a UUID in the UUID List that is used by the command.
If this field is cleared to 0h,then no UUID index is specified.
EXAMPLES
DESCRIPTION
-----------
-This command clears corretable pcie errors for the specified Micron device.
+This command clears correctable pcie errors for the specified Micron device.
The <device> parameter is mandatory and may be either the NVMe
character device (ex: /dev/nvme0), or a namespace block device (ex:
DESCRIPTION
-----------
For the given NVMe device, sends the Micron vendor specific device commands to retrieve
-various logs (in binary format) and compresses them and saves into speficied zip file.
-These vendor unique logs can be analysed with Micron Technical support team for any device
+various logs (in binary format) and compresses them and saves into specified zip file.
+These vendor unique logs can be analyzed with Micron Technical support team for any device
specific issues
The <device> parameter is mandatory and may be either the NVMe
-nvme-micron-temperarature-stats(1)
+nvme-micron-temperature-stats(1)
==================================
NAME
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
On success, the returned Predictable Latency Event Aggregate Log
-Page structure may be returned in one ofseveral ways depending on
+Page 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.
-b::
--raw-binary::
- Print the raw Predectible Latency Event Aggregate log buffer to stdout.
+ Print the raw Predictable Latency Event Aggregate log buffer to stdout.
-o <format>::
--output-format=<format>::
------------
+
-* Print the raw Predectible Latency Event Aggregate log to a file:
+* Print the raw Predictable Latency Event Aggregate log to a file:
+
------------
# nvme pred-lat-event-agg-log /dev/nvme0 --raw-binary > pred_lat_agg_log.raw
NAME
----
-nvme-predictable-lat-log - Send Predectible latency per NVM set log page request,
+nvme-predictable-lat-log - Send Predictable latency per NVM set log page request,
returns result and log
SYNOPSIS
DESCRIPTION
-----------
-Retrieves the NVMe Predectible latency per NVM set log page from an NVMe device
+Retrieves the NVMe Predictable latency per NVM set log page from an NVMe 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 Predectible latency per NVM set log structure
-may be returned in one ofseveral ways depending on the option flags; the
+On success, the returned Predictable latency per NVM set 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.
-------
-i <nvmset_id>::
--nvmset-id=<nvmset_id>::
- Retrieve the Predectible latency per NVM set log for the given nvmset id.
+ Retrieve the Predictable latency per NVM set log for the given nvmset id.
This argument is mandatory and its success may depend on the device's
statistics to provide this log For More details see NVM Express 1.4 Spec.
Section 5.14.1.10. The default nvmset id to use is 1 for the device.
-b::
--raw-binary::
- Print the raw Predectible latency per NVM set log buffer to stdout.
+ Print the raw Predictable latency per NVM set log buffer to stdout.
-o <format>::
--output-format=<format>::
EXAMPLES
--------
-* Print the Predectible latency per NVM set log page in a human readable format:
+* Print the Predictable latency per NVM set log page in a human readable format:
+
------------
# nvme predictable-lat-log /dev/nvme0
------------
+
-* Print the raw Predectible latency per NVM set log to a file:
+* Print the raw Predictable latency per NVM set log to a file:
+
------------
# nvme predictable-lat-log /dev/nvme0 --raw-binary > nvmset_log.raw
fields in a human readable format:
+
------------
-# nvme primary-ctrl-caps /dev/nvme0 --human-readbale
+# nvme primary-ctrl-caps /dev/nvme0 --human-readable
# nvme primary-ctrl-caps /dev/nvme0 -H
------------
NVME
--dir-type=<type>::
Optional directive type. The nvme-cli only enforces the value
be in the defined range for the directive type, though the NVMe
- specifcation (1.3a) defines only one directive, 01h, for write
- stream idenfiers.
+ specification (1.3a) defines only one directive, 01h, for write
+ stream identifiers.
-S <spec>::
--dir-spec=<spec>::
data protection processing.
--force::
- Ignore namespace is currently busy and perfome the operation
+ Ignore namespace is currently busy and performed the operation
even though.
EXAMPLES
RPMB target given with --target or -t options. As per
spec, this is one time action which can't be undone.
- read-couter - Read 'write counter' of specified RPMB target. The
+ read-counter - Read 'write counter' of specified RPMB target. The
counter value read is printed onto STDOUT
read-config - Read 512 bytes of device configuration block data of
-o option should be given to read the amount of data
to be read in 512 byte blocks.
- write-data - Supports authenticated data writting to specified RPMB
+ write-data - Supports authenticated data writing to specified RPMB
target (--target or -t option) at given offset
specified with --address or -o option, using key
specified using --keyfile or -k options. --blocks or
-o <offset>::
--address=<offset>::
The address (in 512 byte sector offset from 0) to be used for data
- trasnfer commands (read or write) for a specified RPMB target.
+ transfer commands (read or write) for a specified RPMB target.
-b::
--blocks=<sectors>::
- The size in 512 byte sectors to be used for data trasnfer commands
+ The size in 512 byte sectors to be used for data transfer commands
(read or write) for a specified RPMB target.
EXAMPLES
# nvme rpmb /dev/nvme0 --cmd=info
-----------
+
-* Program 'SecreteKey' as authentication key for target 1
+* Program 'SecretKey' as authentication key for target 1
+
------------
# nvme rpmb /dev/nvme0 --cmd=program-key -key='SecretKey' --target=1
* Write 200 blocks of (512 bytes) from input.bin onto target 0
+
------------
-# nvme rpmb /dev/nvme0 -c write-data -t 0 -f input.bin -b 200 -k 'SecreteKey'
+# nvme rpmb /dev/nvme0 -c write-data -t 0 -f input.bin -b 200 -k 'SecretKey'
------------
+
* Read 200 blocks of (512 bytes) from target 2, at offset 0x100 and save the
OPTIONS
-------
-d::
---no-delloc::
+--no-dealloc::
No Deallocate After Sanitize:
If set, then the controller shall not deallocate any logical
blocks as a result of successfully completing the sanitize
sanitize operation.
--force::
- Ignore namespace is currently busy and perfome the operation
+ Ignore namespace is currently busy and performed the operation
even though.
EXAMPLES
NAME
----
-nvme-self-test-log - Retrieve the log information initited by device-self-test and display it
+nvme-self-test-log - Retrieve the log information initiated by device-self-test and display it
SYNOPSIS
--------
DESCRIPTION
-----------
-Retrieves the NVMe supportd log pages details from an NVMe device and provides
+Retrieves the NVMe supported log pages details from an NVMe device and provides
the returned structure.
The <device> parameter is mandatory and should be the NVMe character
device (ex: /dev/nvme0).
-On success, the returned supportd log pages log structure will be printed
+On success, the returned supported log pages log structure will be printed
for each command that is supported.
OPTIONS
NAME
----
-nvme-transcend-healthvalue - Use NVMe SMART table to analyse the health value of Transcend device.
+nvme-transcend-healthvalue - Use NVMe SMART table to analyze the health value of Transcend device.
SYNOPSIS
--------
[verse]
-'nvme transcned healthvalue' <device>
+'nvme transcend healthvalue' <device>
DESCRIPTION
-----------
* Print the Transcend Device health value in a human readable format:
+
------------
-# nvme transcned healthvalue /dev/nvme0
+# nvme transcend healthvalue /dev/nvme0
------------
NVME
OPTIONS
-------
-r <NUM>::
---run-tim=<NUM>::
+--run-time=<NUM>::
(optional) Number of hours to log data (default = 20 hours)
-f <NUM>::
|The 2 possible states are : Present or Not Present.
|*Thermal Throttling Status*
-|The 3 possible states are : Off, On, or Unavaiable.
+|The 3 possible states are : Off, On, or Unavailable.
|*Format Corrupt Reason*
|The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.
EXAMPLES
--------
-* Resizes namespace 1 to 50% of the orginal TNVMCAP reported value:
+* Resizes namespace 1 to 50% of the original TNVMCAP reported value:
+
------------
# nvme wdc namespace-resize /dev/nvme0 -n 1 -o 3
------------
-* Resizes namespace 2 to 7% of the orginal TNVMCAP reported value:
+* Resizes namespace 2 to 7% of the original TNVMCAP reported value:
+
------------
# nvme wdc namespace-resize /dev/nvme0 --namespace-id=2 --op-option=1
DESCRIPTION
-----------
-For the NVMe device given, read a Vendor Unique WDC log page that returns the firmware actiation
+For the NVMe device given, read a Vendor Unique WDC log page that returns the firmware activation
history.
The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).
|The new firmware level running on the SSD after the activation took place.
|*Slot Number*
-|The slot tht the firmware is being activated from.
+|The slot that the firmware is being activated from.
|*Commit Action Type*
|The commit action type associated with the firmware activation event
|*Result*
-|The result of the firmware activation event. The ouput shall be in the format:
+|The result of the firmware activation event. The output shall be in the format:
Pass or Failed + error code
|===
SYNOPSIS
--------
[verse]
-'nvme-write-uncorr' <device> [--start-block=<slba> | -s <slba>]
+'nvme-write-uncor' <device> [--start-block=<slba> | -s <slba>]
[--block-count=<nlb> | -c <nlb>]
[--namespace-id=<nsid> | -n <nsid>]
[--force]
Namespace ID use in the command.
--force::
- Ignore namespace is currently busy and perfome the operation
+ Ignore namespace is currently busy and performed the operation
even though.
EXAMPLES
data protection processing.
--force::
- Ignore namespace is currently busy and perfome the operation
+ Ignore namespace is currently busy and performed the operation
even though.
EXAMPLES
--dir-type=<type>::
Optional directive type. The nvme-cli only enforces the value
be in the defined range for the directive type, though the NVMe
- specifcation (1.3a) defines only one directive, 01h, for write
- stream idenfiers.
+ specification (1.3a) defines only one directive, 01h, for write
+ stream identifiers.
-S <spec>::
--dir-spec=<spec>::
data protection processing.
--force::
- Ignore namespace is currently busy and perfome the operation
+ Ignore namespace is currently busy and performed the operation
even though.
EXAMPLES
DESCRIPTION
-----------
-For the NVMe device given, sends the zoned command set's identify namepsace
+For the NVMe device given, sends the zoned command set's identify namespace
command and provides the result and returned structure.
The <device> parameter is mandatory and may be either the NVMe character
SYNOPSIS
--------
[verse]
-'nvme zns setzone-desc' <device> [--namespace-id=<NUM> | -n <NUM>]
+'nvme zns set-zone-desc' <device> [--namespace-id=<NUM> | -n <NUM>]
[--start-lba=<IONUM>, -s <IONUM>]
[--zrwaa | -r]
[-data=<FILE>, -d <FILE>]
DESCRIPTION
-----------
For the NVMe device given, issues the Zone Management Send command with the
-Set Zone Descriptor Extenions action. The input will default to stdin.
+Set Zone Descriptor Extensions action. The input will default to stdin.
Alternatively, the data may come from a file that can be specified. The data
-length will automatically be calculated from the zns identify namesapce.
+length will automatically be calculated from the zns identify namespace.
OPTIONS
-------
the medium from the data data buffer provided. Will use stdin by default
if you don't provide a file.
-On sucess, the program will report the LBA that was assigned to the data for
+On success, the program will report the LBA that was assigned to the data for
the append operation.
OPTIONS
EXAMPLES
--------
-* flush the first zwra of first zone for zrwacg(15) on namespace 1:
+* flush the first zrwa of first zone for zrwacg(15) on namespace 1:
+
------------
# nvme zns zrwa-flush-zone /dev/nvme0 -n 1 -l 15
projects / users / sagi / nvme-cli.git / commitdiff