Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
XNVME-SANITIZE(1)		     xNVMe		     XNVME-SANITIZE(1)

NAME
       xnvme-sanitize -	Start a	Sanitize Operation

SYNOPSIS
       xnvme sanitize <uri> [<args>]

DESCRIPTION
       Start a Sanitize	Operation

REQUIRED
       <uri>  Device URI e.g. '/dev/nvme0n1', '0000:01:00.1', '10.9.8.1.8888',
	      '\.PhysicalDrive1'

       --sanact	0xNUM
	      Sanatize	action:	 Exit Failure Mode=0x1,	Block Erase=0x2, Over-
	      write=0x3, Crypto	Erase=0x4

OPTIONAL
       [ --ause	]
	      Allow Unrestricted Sanatize Exit

       [ --ovrpat 0xNUM	]
	      Overwrite	Pattern

       [ --owpass 0xNUM	]
	      Overwrite	Pass Count

       [ --oipbp ]
	      Overwrite	Invert Pattern Between Passes

       [ --nodas ]
	      No-Deallocate After Sanitize

       [ --subnqn STRING ]
	      Subsystem	 NQN  of  the  NVMe   over   Fabrics   endpoint	  e.g.
	      'nqn.2022-06.io.xnvme:ctrlnode1'

       [ --hostnqn STRING ]
	      The  host	 NQN  to use when connecting to	NVMe over Fabrics con-
	      trollers

       [ --be STRING ]
	      xNVMe backend, e.g. 'linux', 'spdk', 'fbsd',  'macos',  'posix',
	      'windows'

       [ --dev-nsid 0xNUM ]
	      Namespace	Identifier for Device Handle

       [ --admin STRING	]
	      xNVMe admin. command-interface, e.g. 'nvme', 'block'

       [ --mem STRING ]
	      xNVMe buffer/memory manager

       [ --direct NUM ]
	      Bypass layers

       [ --help	]
	      Show usage / help

SEE ALSO
       Full documentation at: <https://xnvme.io/>

AUTHOR
       Written	by Simon A. F. Lund <simon.lund@samsung.com> on	behalf of Sam-
       sung

xNVMe			       09 September 2024	     XNVME-SANITIZE(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=xnvme-sanitize&sektion=1&manpath=FreeBSD+Ports+15.0>

home | help