Home

This wiki collects additional documentation, tips and tricks, etc. around the nvme-cli project.

Getting Started

• Building nvme‐cli

Connecting to NVMe-oF Targets

• How to connect to a target
• How to connect to a target over Fibre Channel
• How to configure NVMe-oF connections (nvme-fabrics.conf)
• Using --host-traddr and --host-iface
• How to set up inband authentication
• How to set up TLS for NVMe-TCP
• How to set up NVMe-oF autoconnect
• NVMe-oF Persistent Discovery Controllers (PDC)
• NVMe-oF Multipath and ANA
• nvme-discoverd

Security & Encryption

• The nvme keys Plugin
• How to securely erase an NVMe device
• How to enable TCG Opal support with nvme‐cli and cryptsetup
• nvme-keysd
• Privilege Separation

Monitoring

• NVMe Prometheus Exporter

Reference

• Migrating from nvme-cli 2.x to 3.0
• OCP documentation
• Troubleshooting

Contributing / Development

• How to add a new INI configuration parameter