'\" t
.\"     Title: ndctl-list
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.26
.\"      Date: 2026-06-30
.\"    Manual: ndctl Manual
.\"    Source: ndctl
.\"  Language: English
.\"
.TH "NDCTL\-LIST" "1" "2026-06-30" "ndctl" "ndctl Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "نام (NAME)"
ndctl-list \- تخلیه مکان‌نگاری و ویژگی‌های دستگاه‌های nvdimm سامانه در قالب json
.SH "خلاصه دستور (SYNOPSIS)"
.sp
.nf
\fIndctl list\fP [<options>]
.fi
.br
.sp
پیمایش تمام گذرگاه‌های nvdimm در سیستم و فهرست کردن تمام دستگاه‌های متصل به همراه برخی از ویژگی‌های اصلی آن‌ها.
.sp
می‌توان گزینه‌هایی را برای محدود کردن خروجی به دستگاه‌هایی از یک کلاس مشخص تعیین کرد. این کلاس‌ها عبارتند از: buses، dimms، regions و namespaces. به‌طور پیش‌فرض، اجرای \fIndctl list\fP بدون هیچ گزینه‌ای معادل دستور زیر است:
.sp
.nf
ndctl list \-\-namespaces \-\-bus=all \-\-region=all
.fi
.br
.SH "مثال‌ها (EXAMPLES)"
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-\-buses \-\-namespaces

{
  "provider":"nfit_test.1",
  "dev":"ndbus2",
  "namespaces":[
    {
      "dev":"namespace9.0",
      "mode":"raw",
      "size":33554432,
      "blockdev":"pmem9"
    }
  ]
}
{
  "provider":"nfit_test.0",
  "dev":"ndbus1"
}
{
  "provider":"e820",
  "dev":"ndbus0",
  "namespaces":[
    {
      "dev":"namespace0.0",
      "mode":"fsdax",
      "size":8589934592,
      "blockdev":"pmem0"
    }
  ]
}
.fam
.fi
.if n .RE
.SH "گزینه‌ها (OPTIONS)"
.sp
\-r, \-\-region=
.RS 4
یک نام دستگاه \fIregionX\fP یا شماره شناسه region. عملیات را به ناحیه(ها)ی مشخص‌شده محدود می‌کند. کلیدواژه \fIall\fP می‌تواند برای مشخص کردن نبود هیچ محدودیتی تعیین شود، با این حال این کار معادل تعیین نکردن گزینه \-\-region است.
.RE
.sp
\-b, \-\-bus=
.RS 4
یک شماره شناسه bus یا یک رشته فراهم‌کننده (مانند "ACPI.NFIT"). عملیات را به گذرگاه(ها)ی مشخص‌شده محدود می‌کند. کلیدواژه \fIall\fP می‌تواند برای مشخص کردن نبود هیچ محدودیتی تعیین شود، با این حال این کار معادل تعیین نکردن گزینه \-\-bus است.
.RE
.sp
\-d, \-\-dimm=
.RS 4
یک نام دستگاه \fInmemX\fP یا شماره شناسه dimm. شماره شناسه dimm در اینجا X در \fInmemX\fP است. خروجی را بر اساس دستگاه‌هایی که به dimm داده‌شده ارجاع دارند فیلتر می‌کند. برای نمونه برای دیدن تمام namespaceهایی که شامل ظرفیت ذخیره‌سازی روی nmem0 هستند:
.RE
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-\-dimm=nmem0 \-\-namespaces
.fam
.fi
.if n .RE
.sp
\-n, \-\-namespace=
.RS 4
یک نام دستگاه \fInamespaceX.Y\fP، یا تاپل شناسه به‌علاوه ناحیه فضای نام \fIX.Y\fP. در صورت وجود، فهرست namespace را به تک دستگاه شناسایی‌شده محدود می‌کند.
.RE
.sp
\-m, \-\-mode=
.RS 4
فیلتر کردن فهرست بر اساس حالت (\fIraw\fP، \fIfsdax\fP، \fIsector\fP یا \fIdevdax\fP) مربوط به namespace(ها).
.RE
.sp
\-U, \-\-numa\-node=
.RS 4
فیلتر کردن فهرست بر اساس گره numa.
.RE
.sp
\-B, \-\-buses
.RS 4
گنجاندن اطلاعات گذرگاه (bus) در فهرست خروجی.
.RE
.sp
\-D, \-\-dimms
.RS 4
گنجاندن اطلاعات dimm در فهرست خروجی.
.RE
.sp
.nf
{
  "dev":"nmem0",
  "id":"cdab\-0a\-07e0\-ffffffff",
  "handle":0,
  "phys_id":0,
  "security:":"disabled"
}
.fi
.br
.sp
\-H, \-\-health
.RS 4
گنجاندن اطلاعات سلامت dimm در فهرست خروجی. برای نمونه:
.RE
.sp
.nf
{
  "dev":"nmem0",
  "health":{
    "health_state":"non\-critical",
    "temperature_celsius":23,
    "spares_percentage":75,
    "alarm_temperature":true,
    "alarm_spares":true,
    "temperature_threshold":40,
    "spares_threshold":5,
    "life_used_percentage":5,
    "shutdown_state":"clean"
  }
}
.fi
.br
.sp
\-F, \-\-firmware
.RS 4
گنجاندن اطلاعات سفت‌افزار در فهرست خروجی، شامل وضعیت و قابلیت فعال‌سازی سفت‌افزار در زمان اجرا:
.RE
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-BDF
[
  {
    "provider":"nfit_test.0",
    "dev":"ndbus2",
    "scrub_state":"idle",
    "firmware":{
      "activate_method":"suspend",
      "activate_state":"idle"
    },
    "dimms":[
      {
        "dev":"nmem1",
        "id":"cdab\-0a\-07e0\-ffffffff",
        "handle":0,
        "phys_id":0,
        "security":"disabled",
        "firmware":{
          "current_version":0,
          "can_update":true
        }
      },
\&...
]
.fam
.fi
.if n .RE
.sp
\-X, \-\-device\-dax
.RS 4
گنجاندن جزئیات device\-dax ("daxregion") هنگامی که یک namespace در حالت "devdax" است.
.RE
.sp
.nf
{
  "dev":"namespace0.0",
  "mode":"devdax",
  "size":4225761280,
  "uuid":"18ae1bbb\-bb62\-4efc\-86df\-4a5caacb5dcc",
  "daxregion":{
    "id":0,
    "size":4225761280,
    "align":2097152,
    "devices":[
      {
        "chardev":"dax0.0",
        "size":4225761280
      }
    ]
  }
}
.fi
.br
.sp
\-R, \-\-regions
.RS 4
گنجاندن اطلاعات ناحیه (region) در فهرست خروجی.
.RE
.sp
\-N, \-\-namespaces
.RS 4
گنجاندن اطلاعات فضای نام (namespace) در فهرست خروجی. در صورتی که گزینه دیگری به دستور داده نشود، اطلاعات namespace به‌طور پیش‌فرض فهرست می‌شود.
.RE
.sp
\-i, \-\-idle
.RS 4
گنجاندن دستگاه‌های بیکار (فعال‌نشده) در فهرست خروجی.
.RE
.sp
\-c, \-\-configured
.RS 4
گنجاندن دستگاه‌های پیکربندی‌شده (namespaceهای با اندازه غیرصفر) بدون در نظر گرفتن فعال بودن یا نبودن آن‌ها. سایر دستگاه‌ها به جز namespaceها همیشه «پیکربندی‌شده» در نظر گرفته می‌شوند.
.RE
.sp
\-C, \-\-capabilities
.RS 4
گنجاندن قابلیت‌های ناحیه در فهرست خروجی؛ یعنی حالت‌های پشتیبانی‌شده namespace و ویژگی‌های متغیر مانند اندازه‌های بخش (sector) و هم‌ترازی‌ها.
.RE
.sp
\-M, \-\-media\-errors
.RS 4
گنجاندن خطاهای رسانه (badblocks) در فهرست خروجی. توجه داشته باشید که ویژگی \fIbadblock_count\fP در صورت غیرصفر بودن مقدار، به‌طور پیش‌فرض در خروجی گنجانده می‌شود، در غیر این صورت پنهان است. همچنین، اگر namespace در حالت \fIsector\fP باشد، فهرست \fIbadblocks\fP گنجانده نمی‌شود و ویژگی \fIbadblock_count\fP ممکن است بلوک‌هایی را که در فراداده (metadata) یا ظرفیت استفاده‌نشده namespace قرار دارند نیز در بر بگیرد. برای فهرست کردن آفست‌های دقیق \fIbadblocks\fP، یک namespace از نوع \fIsector\fP را به حالت \fIraw\fP تبدیل کنید.
.RE
.sp
.nf
{
  "dev":"namespace7.0",
  "mode":"raw",
  "size":33554432,
  "blockdev":"pmem7",
  "badblock_count":17,
  "badblocks":[
    {
      "offset":4,
      "length":1
    },
    {
      "offset":32768,
      "length":8
    },
    {
      "offset":65528,
      "length":8
    }
  ]
}
.fi
.br
.sp
\-v, \-\-verbose
.RS 4
افزایش پرگویی خروجی. این گزینه می‌تواند چندین بار برای نمایش جزئیات بیشتر در خروجی‌های اطلاعاتی و متفرقه تعیین شود، و می‌تواند برای نادیده گرفتن پرچم‌های حذف‌شده جهت نمایش اطلاعات خاص به کار رود.
.br
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\fB\-v\fP
علاوه بر خروجی پیش‌فرض namespaceهای فعال، مقادیر numa_node، raw_uuid و خطاهای رسانه بلوک‌های بد را نمایش می‌دهد.
.br
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\fB\-vv\fP
شامل تمام موارد ارائه‌شده توسط \fI\-v\fP، به‌علاوه فعال‌سازی خودکار \-\-dimms، \-\-buses و \-\-regions.
.br
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\fB\-vvv\fP
شامل تمام موارد ارائه‌شده توسط \fI\-vv\fP، به‌علاوه \-\-health، \-\-capabilities، \-\-idle و \-\-firmware.
::
همچنین می‌توان محدوده پرگویی را بر اساس نوع شیء تعیین کرد. برای نمونه فقط برای فهرست کردن regionها به همراه قابلیت‌ها و اطلاعات خطای رسانه.
.RE
.RE
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-Ru \-vvv \-r 0
{
  "dev":"region0",
  "size":"4.00 GiB (4.29 GB)",
  "available_size":0,
  "max_available_extent":0,
  "type":"pmem",
  "numa_node":0,
  "target_node":2,
  "capabilities":[
    {
      "mode":"sector",
      "sector_sizes":[
        512,
        520,
        528,
        4096,
        4104,
        4160,
        4224
      ]
    },
    {
      "mode":"fsdax",
      "alignments":[
        4096,
        2097152,
        1073741824
      ]
    },
    {
      "mode":"devdax",
      "alignments":[
        4096,
        2097152,
        1073741824
      ]
    }
  ],
  "persistence_domain":"unknown"
}
.fam
.fi
.if n .RE
.sp
\-u, \-\-human
.RS 4
قالب‌بندی اعدادی که اندازه فضای ذخیره‌سازی یا آفست‌ها را نشان می‌دهند به‌صورت رشته‌های خوانا برای انسان به همراه یکاها، به جای قالب پیش‌فرض عدد صحیح خام که مناسب ماشین است. همچنین فیلدهای عددی دیگر را به رشته‌های هگزادسیمال تبدیل می‌کند.
.RE
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-\-region=7
{
  "dev":"region7",
  "size":67108864,
  "available_size":67108864,
  "type":"pmem",
  "iset_id":\-6382611090938810793,
  "badblock_count":8
}
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-\-human \-\-region=7
{
  "dev":"region7",
  "size":"64.00 MiB (67.11 MB)",
  "available_size":"64.00 MiB (67.11 MB)",
  "type":"pmem",
  "iset_id":"0xa76c6907811fae57",
  "badblock_count":8
}
.fam
.fi
.if n .RE.SH "متغیرهای محیطی (ENVIRONMENT VARIABLES)"
.sp
\fINDCTL_LIST_LINT\fP
.RS 4
یک باگ در خروجی «ndctl list» باید با احتیاط نسبت به سایر ابزارهایی که ممکن است به این رفتار دارای باگ وابسته شده باشند برطرف شود. متغیر NDCTL_LIST_LINT سازوکاری اختیاری برای اعمال اصلاحات است تا رفتار قبلاً منتشرشده به‌طور پیش‌فرض دچار پس‌رفت (regression) نشود. این متغیر محیطی اصلاحات زیر را اعمال می‌کند:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
اصلاح «ndctl list \-Rv» به‌گونه‌ای که تنها اشیاء region را نشان دهد و شامل اشیاء namespace نشود.
::
.RE
.RE
.SH "کپی‌رایت و تکثیر (COPYRIGHT)"
.sp
حق نشر \(co 2016 \- 2022، شرکت Intel. مجوز GPLv2: گنو GPL
نسخه ۲ \c
.URL "http://gnu.org/licenses/gpl.html" "" "."
این نرم‌افزار آزاد است:
شما مجاز به تغییر و بازتوزیع آن هستید. هیچ‌گونه ضمانتی وجود ندارد، تا
حدی که قانون اجازه می‌دهد.
.SH "همچنین ببینید (SEE ALSO)"
.sp
ndctl\-create\-namespace(1)