VNSTAT(1) User Manuals VNSTAT(1)

vnstat - پایشگر ترافیک شبکه مبتنی بر کنسول

vnstat [-5bDedhlmqstvy?] [--95th] [--add] [--alert output exit type condition limit unit] [--begin date] [--config file] [--days [limit]] [--db file] [--dbdir directory] [--dbiflist [mode]] [--debug] [--end date] [--fiveminutes [limit]] [--help] [-hg] [--hours [limit]] [--hoursgraph] [-i interface] [--iface interface] [--iflist [mode]] [--json [mode] [limit]] [--limit limit] [--live [mode]] [--locale locale] [--longhelp] [--merge source destination] [--months [limit]] [--oneline [mode]] [--query [mode]] [--rateunit [mode]] [--remove] [--rename name] [-ru [mode]] [--setalias alias] [--short] [--showconfig] [--style number] [--top [limit]] [-tr [time]] [--traffic [time]] [--version] [--xml [mode] [limit]] [--years [limit]] [interface].SHتوضیحات (DESCRIPTION)

vnStat یک ناظر ترافیک شبکه مبتنی بر کنسول است. این ابزار لاگی از ترافیک شبکه در بازه‌های ۵ دقیقه‌ای، ساعتی، روزانه، ماهانه و سالانه برای رابط(های) انتخاب‌شده نگهداری می‌کند. با این حال، یک شنودگر بسته نیست. اطلاعات ترافیک بسته به دردسترس‌بودن از سیستم‌های فایل proc(5) یا sys خوانده می‌شود که صرف‌نظر از نرخ ترافیک شبکه، منجر به استفاده ناچیز از منابع سیستم می‌گردد. بدین ترتیب vnStat می‌تواند در بیشتر سیستم‌ها حتی بدون مجوزهای root استفاده شود.

عملکرد این نرم‌افزار به دو دستور تقسیم شده است. هدف دستور vnstat ارائه رابطی برای پرس‌وجوی اطلاعات ترافیک ذخیره‌شده در پایگاه‌داده است، در حالی که دیمن vnstatd(8) مسئولیت بازیابی داده‌ها، حافظه موقت (caching) و ذخیره‌سازی را بر عهده دارد. با اینکه فرایند دیمن به طور مداوم به عنوان یک سرویس در حال اجرا است، اما در واقع بیشتر زمان خود را بین به‌روزرسانی‌های داده در حالت خواب سپری می‌کند.

--95th
نمایش خروجی صدک ۹۵ام (95th percentile) برای ماه جاری. این خروجی از داده‌های با تفکیک ۵ دقیقه‌ای ماه جاری برای محاسبه نرخ ترافیک صدک ۹۵ام جهت ترافیک دریافتی، ارسالی و مجموع استفاده می‌کند. علاوه بر این، حداقل، میانگین و حداکثر نرخ ترافیک برای مقادیر دریافتی، ارسالی و مجموع نیز نمایش داده می‌شود. برای ذخیره تمام داده‌های لازم، این خروجی نیازمند آن است که گزینه پیکربندی 5MinuteHours حداقل مقدار 744 را داشته باشد، در غیر این صورت پوشش ۱۰۰٪ امکان‌پذیر نخواهد بود.
ایجاد مدخل در پایگاه‌داده برای رابط مشخص‌شده با گزینه -i یا --iface. دیمن می‌تواند هنگام انجام این عملیات در حال اجرا باشد و در صورتی که گزینه پیکربندی RescanDatabaseOnSave فعال باشد، رابط را بدون نیاز به راه‌اندازی مجدد در بازه زمانی SaveInterval دقیقه به طور خودکار مانیتور می‌کند. در غیر این صورت، برای شروع مانیتور رابط اضافه‌شده، دیمن باید مجدداً راه‌اندازی شود.
بسته به مقادیر پارامترهای ارائه‌شده، هنگام وقوع وضعیت پیکربندی‌شده، یک هشدار نمایش می‌دهد، از وضعیت خروج متفاوت استفاده می‌کند یا ترکیبی از هر دو را به کار می‌برد.
پارامتر output عددی از 0 تا 3 می‌گیرد و خروجی دادن دستور را کنترل می‌کند. مقدار '0' هرگز خروجی تولید نمی‌کند، '1' همیشه خروجی تولید می‌کند، '2' تنها زمانی خروجی را نمایش می‌دهد که تخمین مصرف از limit فراتر رود و '3' تنها زمانی خروجی را نشان می‌دهد که مصرف عملاً از limit فراتر رفته باشد.
پارامتر exit عددی از 0 تا 5 می‌گیرد و وضعیت خروج دستور را کنترل می‌کند. مقدار '0' همیشه از وضعیت خروج 0 استفاده می‌کند، '1' همیشه از وضعیت خروج 1 استفاده می‌کند، '2' در صورتی که تخمین مصرف از limit بیشتر شود از وضعیت خروج 1 و در غیر این صورت از 0 استفاده می‌کند، و '3' در صورتی که مصرف از limit فراتر رفته باشد وضعیت خروج 1 و در غیر این صورت وضعیت خروج 0 را برمی‌گرداند. مقادیر '4' و '5' معادل '2' و '3' هستند، با این تفاوت که هنگام برقراری شرط، به جای وضعیت خروج 1 از وضعیت خروج 2 استفاده می‌شود. از آنجا که خطاها همیشه از وضعیت خروج 1 استفاده می‌کنند، این قابلیت می‌تواند به تفکیک هشدارها از خطاها کمک کند.
پارامتر type مشخص می‌کند که limit با مصرف کدام نوع بازه زمانی مقایسه شود. گزینه‌های دردسترس: 'h'، 'hour'، 'hourly'، 'd'، 'day'، 'daily'، 'm'، 'month'، 'monthly'، 'y'، 'year'، 'yearly'، 'p'، '95'، '95%'.
پارامتر condition مشخص می‌کند که آیا limit با ترافیک دریافتی (rx)، ارسالی (tx)، کل یا مصرف برآوردشده این سه مورد مقایسه شود. گزینه‌های دردسترس: 'rx'، 'tx'، 'total'، 'rx_estimate'، 'tx_estimate'، 'total_estimate'. گزینه‌های تخمین برای type صدک ۹۵ام دردسترس نیستند.
مقدار limit یک عدد صحیح بدون اعشار و بزرگ‌تر از صفر است که حد مجاز مصرف ترافیک را با واحد تعیین‌شده توسط پارامتر unit مشخص می‌کند. پارامتر unit گزینه‌های زیر را می‌پذیرد: 'B'، 'KiB'، 'MiB'، 'GiB'، 'TiB'، 'PiB'، 'EiB'، 'KB'، 'MB'، 'GB'، 'TB'، 'PB'، 'EB'. برای type صدک ۹۵ام گزینه‌های زیر دردسترس هستند: 'B/s'، 'KiB/s'، 'MiB/s'، 'GiB/s'، 'TiB/s'، 'PiB/s'، 'EiB/s'، 'kB/s'، 'MB/s'، 'GB/s'، 'TB/s'، 'PB/s'، 'EB/s'، 'bit/s'، 'Kibit/s'، 'Mibit/s'، 'Gibit/s'، 'Tibit/s'، 'Pibit/s'، 'Eibit/s'، 'kbit/s'، 'Mbit/s'، 'Gbit/s'، 'Tbit/s'، 'Pbit/s'، 'Ebit/s'. برای فعال شدن هشدار، میزان مصرف باید از limit فراتر رود. مصرف دقیقاً برابر با مقدار limit باعث ایجاد هشدار نمی‌شود.
محاسبه تخمین تنها محدود به گزینه‌های برآورد در پارامتر condition نیست، بلکه می‌تواند با استفاده از گزینه تخمین در پارامترهای output یا exit نیز حاصل شود. نبود پارامترها یا نامعتبر بودن آنها یا ترکیب نامعتبر پارامترها منجر به نمایش راهنمای اختصاصی --alert خواهد شد.
شروع خروجی فهرست از یک تاریخ / زمان خاص که توسط date مشخص شده است، به جای اینکه نقطه شروع بر اساس تعداد مدخل‌های نمایش‌داده‌شده انتخاب شود. اگر date در پایگاه‌داده وجود نداشته باشد، نزدیک‌ترین تاریخ پس از آن استفاده خواهد شد. پارامتر date از این قالب‌ها پشتیبانی می‌کند: YYYY-MM-DD HH:MM و YYYY-MM-DD و "today". این گزینه فقط با خروجی‌های --json، --xml و خروجی‌های فهرستی قابل استفاده است.
استفاده از file به عنوان فایل پیکربندی به جای استفاده از قابلیت جستجوی خودکار فایل پیکربندی. اگر گزینه --config چندین بار استفاده شود، در صورت وجود تنظیمات متداخل، تنظیمات فایل‌های بعدی در خط فرمان، تنظیمات بارگذاری‌شده از فایل‌های قبلی را بازنویسی خواهند کرد.
نمایش آمار ترافیک به صورت روزانه برای روزهای اخیر. طول فهرست به ۳۰ مدخل محدود خواهد بود، مگر اینکه خلاف آن پیکربندی شده باشد یا از پارامتر اختیاری limit استفاده شود. در صورتی که مقدار limit روی 0 تنظیم شود، تمام مدخل‌های ذخیره‌شده در پایگاه‌داده نمایش داده خواهند شد.
استفاده از file به عنوان فایل پایگاه‌داده به جای جستجو برای پایگاه‌داده در دایرکتوری مشخص‌شده در فایل پیکربندی یا مقدار پیش‌فرض تعبیه‌شده در برنامه (در صورت عدم وجود فایل پیکربندی). این گزینه بر --dbdir اولویت دارد و آن را لغو می‌کند.
استفاده از directory به عنوان دایرکتوری پایگاه‌داده به جای دایرکتوری مشخص‌شده در فایل پیکربندی یا مقدار پیش‌فرض تعبیه‌شده در برنامه (در صورت در دسترس نبودن فایل پیکربندی). در صورتی که --db نیز مشخص شده باشد، این گزینه نادیده گرفته می‌شود.
فهرست کردن رابط‌های موجود فعلی در پایگاه‌داده. اگر mode تعریف نشده باشد یا روی 0 تنظیم شود، خروجی در یک قالب تک‌خطی با جزئیات (verbose) نمایش داده می‌شود. اگر mode روی 1 تنظیم شود، خروجی شامل یک رابط در هر خط خواهد بود و اگر mode روی 2 تنظیم گردد، تنها تعداد رابط‌ها به صورت یک عدد منفرد نمایش داده خواهد شد. همچنین ببینید: --iflist..TP -D, --debug نمایش خروجی اشکال‌زدایی بیشتر.
پایان دادن به خروجی فهرست با یک تاریخ / زمان مشخص که توسط date تعیین شده است، به‌جای آخرین تاریخ / زمان موجود در پایگاه داده. اگر date در پایگاه داده در دسترس نباشد، نزدیک‌ترین تاریخ پیش از آن استفاده خواهد شد. date از قالب‌های روبرو پشتیبانی می‌کند: YYYY-MM-DD HH:MM و YYYY-MM-DD. این گزینه فقط می‌تواند با --json ، --xml و خروجی‌های فهرستی استفاده شود. در خروجی‌های فهرستی، خط تخمین با یک خط مجموع جایگزین می‌شود که مقادیر آن نشان‌دهندهٔ مجموع هر ستون است. خط مجموع تنها در صورتی نشان داده می‌شود که خروجی شامل بیش از یک خط داده باشد. این مورد حتی اگر date تعیین‌شده با تاریخ جاری یکسان باشد نیز اعمال می‌شود. فهرست برترین‌ها همچنین نیازمند استفادهٔ هم‌زمان از --begin به‌همراه این گزینه است.
-5, --fiveminutes [limit]
نمایش آمار ترافیک با تفکیک زمانی ۵ دقیقه‌ای برای ساعت‌های گذشته. طول فهرست به ۲۴ مدخل محدود خواهد شد مگر آنکه به‌گونهٔ دیگری پیکربندی شده باشد یا از پارامتر اختیاری limit استفاده شود. در صورتی که limit روی 0 تنظیم شود، تمام مدخل‌های ذخیره‌شده در پایگاه داده نمایش داده خواهند شد.
نمایش آمار ترافیک به‌صورت ساعتی. طول فهرست به ۲۴ مدخل محدود خواهد شد مگر آنکه به‌گونهٔ دیگری پیکربندی شده باشد یا از پارامتر اختیاری limit استفاده شود. در صورتی که limit روی 0 تنظیم شود، تمام مدخل‌های ذخیره‌شده در پایگاه داده نمایش داده خواهند شد.
نمایش آمار ترافیک به‌صورت ساعتی برای ۲۴ ساعت گذشته با استفاده از یک نمودار میله‌ای به همراه یک جدول که نشان‌دهندهٔ داده‌های عددی است.
انتخاب یک interface خاص و اعمال عملیات‌ها تنها بر روی آن. برای پرس‌وجوهای پایگاه داده، امکان ادغام اطلاعات دو یا چند رابط با استفاده از نحوِ interface1+interface2+... وجود دارد. هنگام استفاده از نحو ادغام، تمامی رابط‌های ارائه‌شده باید یکتا باشند و در پایگاه داده وجود داشته باشند. به‌صورت اختیاری، بسته به تنظیمات پیکربندی InterfaceMatchMethod، می‌توان interface را با یک alias که پیش‌تر با استفاده از --setalias تنظیم شده است جایگزین کرد. هنگام استفاده از alias از نحو ادغام پشتیبانی نمی‌شود. گزینهٔ -i, --iface اختیاری است و interface می‌تواند به‌عنوان پارامتر در خط فرمان برای انتخاب رابط مورد استفاده به کار رود، حتی بدون اینکه گزینه به‌طور صریح استفاده شده باشد.
فهرست کردن رابط‌های در دسترس کنونی. اگر mode تعریف نشده باشد یا روی 0 تنظیم شده باشد، خروجی از یک قالب پرگوی تک‌خطی استفاده خواهد کرد. اگر mode روی 1 تنظیم شود، خروجی شامل یک رابط در هر خط خواهد بود و اگر mode روی 2 تنظیم شود، تنها تعداد رابط‌ها به‌صورت یک عدد منفرد نشان داده خواهد شد. همچنین ببینید: --dbiflist.
نمایش محتوای پایگاه داده برای رابط انتخابی یا تمامی رابط‌ها در قالب json. تمامی مقادیر ترافیک در خروجی به بایت هستند مگر آنکه نام کلید به‌گونهٔ دیگری مشخص کرده باشد. پارامتر اختیاری mode می‌تواند برای محدود کردن خروجی تنها به اطلاعات انتخابی استفاده شود. به‌طور پیش‌فرض، همه‌چیز به جز خروجی صدک نود و پنجم نمایش داده می‌شود. تنظیم mode روی 's' خلاصه‌ای شامل ۲ مدخل آخر از داده‌های با تفکیک زمانی ۵ دقیقه‌ای، ساعتی، روزانه، ماهانه و سالانه را خروجی می‌دهد؛ 'f' تنها مدخل‌های با تفکیک ۵ دقیقه‌ای را خروجی می‌دهد؛ 'h' ساعت‌ها، 'd' روزها، 'm' ماه‌ها، 'y' سال‌ها، 't' روزهای برتر و 'p' صدک نود و پنجم را نمایش می‌دهد. متناوباً یا در ترکیب با mode یک پارامتر اختیاری limit می‌تواند برای محدود کردن تعداد مدخل‌ها در خروجی استفاده شود. گزینهٔ --json می‌تواند در ترکیب با گزینه‌های -l, --live و -tr استفاده شود بدون اینکه mode یا limit هیچ تأثیری بر خروجی داشته باشند. فیلد jsonversion در خروجی شامل اطلاعات نگارش API است. این فیلد تنها زمانی تغییر خواهد کرد که نام‌ها یا ساختارهای محتوای از پیش موجود تغییر کنند. در مقایسه، فیلد vnstatversion تنها به‌عنوان اطلاعات اضافی وجود دارد.
تنظیم حداکثر تعداد مدخل‌های نمایش‌داده‌شده در خروجی‌های فهرستی روی limit. استفاده از --limit مقادیر پیش‌فرض محدودیت مدخل‌های فهرست و پارامتر اختیاری limit را که مستقیماً برای یک پرس‌وجوی فهرستی داده شده است بازنویسی می‌کند. در صورتی که limit روی 0 تنظیم شود، تمام مدخل‌های ذخیره‌شده در پایگاه داده نمایش داده خواهند شد. --limit همچنین می‌تواند برای کنترل طول خروجی‌های --json و --xml استفاده شود.
نمایش نرخ انتقال کنونی برای رابط انتخابی به‌صورت بلادرنگ تا زمانی که متوقف شود. در صورتی که مدت زمان اجرا بیش از ۱۰ ثانیه باشد، آمار پس از توقف نمایش داده خواهد شد. یک پارامتر اختیاری mode می‌تواند برای انتخاب بین نمایش تعداد بسته‌ها بر ثانیه (حالت 0) و شمارنده‌های انتقال (حالت 1) در طول اجرا استفاده شود. --style نیز می‌تواند برای تأثیرگذاری بر چیدمان خروجی استفاده شود. در صورت استفاده در ترکیب با گزینهٔ --json خروجی در قالب json خواهد بود.
استفاده از locale به‌جای تنظیمات محلی مشخص‌شده در فایل پیکربندی یا پیش‌فرض سیستم در صورتی که هیچ فایل پیکربندی‌ای در دسترس نباشد.
نمایش فهرست کامل گزینه‌ها.
ادغام داده‌های رابط از پایگاه دادهٔ source در پایگاه دادهٔ destination. مگر در حالتی که رابط‌ها مشخص شده باشند، تمامی رابط‌ها از source در destination ادغام خواهند شد. اگر destination وجود نداشته باشد، یک پایگاه دادهٔ جدید ایجاد خواهد شد. اگر رابطی با همان نام در destination وجود نداشته باشد، یک عملیات رونوشت مستقیم برای داده‌ها از source اجرا خواهد شد. اگر رابطی با همان نام از قبل در destination موجود باشد، یک عملیات ادغام افزایشی اجرا خواهد شد. پایگاه دادهٔ source همیشه به‌صورت فقط‌خواندنی باز می‌شود و هرگز توسط عملیات ادغام تغییر نخواهد کرد. تغییرات در پایگاه دادهٔ destination قابل بازگشت نیستند زیرا از عملیات تفریق یا کاهش پشتیبانی نمی‌شود. اجرای ادغام نیازمند تأیید با یک پارامتر اضافی است. در صورتی که این پارامتر اضافی ارائه نشود، پیش‌نمایشی از عملیات به همراه راهنمایی‌های بیشتر نمایش داده خواهد شد..IP هر دو source و destination می‌توانند مستقیماً به فایل‌های پایگاه داده اشاره کنند یا از ساختار نحوی جایگزین file:interface استفاده کنند که در آن، فایل پایگاه داده دارای پسوند : به همراه یک نام واسط است. هنگامی که به عنوان source استفاده شود، این ساختار نحوی جایگزین امکان تعیین یک واسط را برای ادغام از source به destination به جای ادغام همهٔ واسط‌ها فراهم می‌کند. علاوه بر این، استفاده از این ساختار نحوی جایگزین در destination برای مشخص کردن واسطی که داده‌ها باید با آن ادغام شوند، امکان‌پذیر است.
نمایش آمار ترافیک به صورت ماهانه برای ماه‌های اخیر. طول این فهرست به ۱۲ مورد محدود خواهد شد، مگر آنکه طور دیگری پیکربندی شده باشد یا از پارامتر اختیاری limit استفاده شود. در صورتی که limit بر روی 0 تنظیم شود، تمامی ورودی‌های ذخیره‌شده در پایگاه داده نمایش داده خواهند شد.
نمایش خلاصهٔ ترافیک واسط انتخاب‌شده در یک خط با قالبی قابل تجزیه. خروجی شامل ۱۵ فیلد است که از ; به عنوان جداکنندهٔ فیلد در آن استفاده شده است. نخستین فیلد حاوی اطلاعات نسخهٔ API خروجی است که در نسخه‌های بعدی تنها در صورت تغییر محتوا یا ساختار فیلدها تغییر خواهد کرد. فیلدهای بعدی به ترتیب عبارتند از: ۲) نام واسط، ۳) برچسب زمانی برای امروز، ۴) rx برای امروز، ۵) tx برای امروز، ۶) مجموع برای امروز، ۷) نرخ میانگین ترافیک برای امروز، ۸) برچسب زمانی برای ماه جاری، ۹) rx برای ماه جاری، ۱۰) tx برای ماه جاری، ۱۱) مجموع برای ماه جاری، ۱۲) نرخ میانگین ترافیک برای ماه جاری، ۱۳) مجموع کل rx، ۱۴) مجموع کل tx، ۱۵) مجموع کل ترافیک. یک پارامتر اختیاری mode می‌تواند برای اجبار به نمایش تمام فیلدها بر حسب بایت بدون نمایش خود یکا استفاده شود.
اجبار به استفاده از حالت پرس‌وجوی پایگاه داده. می‌توان از پارامتر اختیاری mode برای بازنویسی حالت پرس‌وجوی پیش‌فرض استفاده کرد. مقدار 'a' باعث می‌شود هنگامی که بیش از یک واسط در پایگاه داده وجود دارد از خروجی خلاصهٔ کوتاه استفاده شود، در غیر این صورت خروجی خلاصهٔ عادی به کار می‌رود. مقدار 's' صرف‌نظر از تعداد واسط‌های موجود در پایگاه داده، باعث نمایش خروجی خلاصهٔ عادی برای یک واسط می‌شود. هنگامی که پارامتر اختیاری mode تعریف نشده باشد، مقدار پیکربندی‌شدهٔ QueryMode به جای آن استفاده خواهد شد.
حذف ورودی پایگاه داده برای واسط مشخص‌شده با -i یا --iface و توقف پایش آن. دیمن می‌تواند در حین این عملیات در حال اجرا باشد و به صورت خودکار تغییرات را شناسایی خواهد کرد.
تغییر نام واسط مشخص‌شده با -i یا --iface در پایگاه داده به نام جدید name. نام جدید نمی‌تواند از قبل در پایگاه داده وجود داشته باشد. این عملیات باعث از دست رفتن هیچ داده‌ای نمی‌شود. دیمن نباید در حین این عملیات در حال اجرا باشد.
تعویض یکای نرخ پیکربندی‌شده. اگر نرخ برای نمایش بر حسب بایت پیکربندی شده باشد، در صورت حضور این گزینه نرخ بر حسب بیت نمایش داده خواهد شد. به همین ترتیب، اگر نرخ برای نمایش بر حسب بیت تنظیم شده باشد، با حضور این گزینه بر حسب بایت نمایش داده می‌شود. به عنوان جایگزین، mode با مقدار 0 یا 1 می‌تواند به عنوان پارامتر این گزینه استفاده شود تا صرف‌نظر از تنظیمات فایل پیکربندی، بین بایت (0) و بیت (1) انتخاب صورت گیرد.
تنظیم alias به عنوان یک نام مستعار برای واسط انتخاب‌شده جهت نمایش در پرس‌وجوها. نام مستعارِ تنظیم‌شده را می‌توان با مشخص کردن یک رشتهٔ خالی برای alias حذف کرد. دیمن می‌تواند در حین این عملیات در حال اجرا باشد.
استفاده از حالت خروجی کوتاه. این حالت همچنین زمانی استفاده می‌شود که بیش از یک واسط در پایگاه داده موجود باشد و هیچ واسط خاصی انتخاب نشده باشد.
نمایش پیکربندی فعلی با همان قالبی که خودِ فایل پیکربندی استفاده می‌کند.
تغییر محتوا و سبک خروجی‌ها. تنظیم number بر روی 0 برای خروجی باریک‌تر، 1 برای فعال‌سازی ستون میله‌ای، 2 همانند حالت قبلی اما با نمایش نرخ میانگین ترافیک در خروجی خلاصه، و 3 برای فعال‌سازی نرخ میانگین ترافیک در تمام خروجی‌هایی که از آن پشتیبانی می‌کنند. مقدار 4 استفاده از نویسه‌های کنترلی ترمینال را در حالت‌های -l, --live و -tr, --traffic غیرفعال می‌کند.
نمایش روزهای با بیشترین ترافیک در تمام دوران. طول فهرست به ۱۰ مورد محدود خواهد شد، مگر آنکه طور دیگری پیکربندی شده باشد یا از پارامتر اختیاری limit استفاده شود. در صورتی که limit بر روی 0 تنظیم شود، تمام ورودی‌های ذخیره‌شده در پایگاه داده نمایش داده خواهند شد. هنگام استفاده با --begin و در صورت تمایل با --end، فهرست به جای ورودی‌های برتر جداگانه، با استفاده از داده‌های روزانه تولید خواهد شد. در دسترس بودن داده‌های روزانه، محدوده‌ای را که پرس‌وجوی وابسته به تاریخ می‌تواند به آن دسترسی داشته باشد، تعیین می‌کند.
محاسبهٔ مقدار ترافیک عبوری از واسط انتخاب‌شده در طول time ثانیه داده‌شده. در صورتی که پارامتر عددی مشخص نشود، time برابر با ۵ ثانیه خواهد بود. خروجی در صورت ترکیب با گزینهٔ --json در قالب json خواهد بود. با این حال، در این حالت شمارش معکوسِ پیش از نتایج نمایش داده نمی‌شود. همچنین می‌توان از --style برای اثرگذاری بر چیدمان خروجی استفاده کرد.
نمایش نسخهٔ فعلی.
نمایش محتوای پایگاه داده برای واسط انتخاب‌شده یا تمام واسط‌ها در قالب xml. تمام مقادیر ترافیک در خروجی بر حسب بایت هستند مگر آنکه نام کلید خلاف آن را نشان دهد. از پارامتر اختیاری mode می‌توان برای محدود کردن خروجی تنها به اطلاعات منتخب استفاده کرد. به طور پیش‌فرض، همه چیز به جز خروجی صدک ۹۵ام نشان داده می‌شود. تنظیم mode روی 's' خلاصه‌ای شامل ۲ ورودی آخر داده‌های تفکیک‌پذیری ۵ دقیقه‌ای، ساعتی، روزانه، ماهانه و سالانه را ارائه می‌دهد؛ 'f' تنها ورودی‌های تفکیک‌پذیری ۵ دقیقه‌ای را خروجی می‌دهد، 'h' ساعت‌ها، 'd' روزها، 'm' ماه‌ها، 'y' سال‌ها، 't' روزهای برتر و 'p' صدک ۹۵ام را نمایش می‌دهد. به عنوان جایگزین یا در ترکیب با mode می‌توان از پارامتر اختیاری limit برای محدود کردن تعداد ورودی‌ها در خروجی استفاده کرد. فیلد xmlversion در خروجی شامل اطلاعات نسخهٔ API است. این فیلد تنها زمانی تغییر خواهد کرد که نام‌ها یا ساختارهای محتوای از قبل موجود تغییر کنند. در مقایسه، فیلد vnstatversion تنها به عنوان اطلاعات اضافه وجود دارد.
نمایش آمار ترافیک به صورت سالانه برای سال‌های اخیر. فهرست به طور پیش‌فرض تمام ورودی‌ها را نمایش خواهد داد مگر آنکه طور دیگری پیکربندی شده باشد یا از پارامتر اختیاری limit استفاده شود. در صورتی که limit بر روی 0 تنظیم شود، تمامی ورودی‌های ذخیره‌شده در پایگاه داده نیز نشان داده خواهند شد..TP -?, --help نمایش خلاصه‌ای از گزینه‌های دستور.

/var/lib/vnstat/
دایرکتوری پیش‌فرض پایگاه‌داده.
/etc/vnstat.conf
فایل پیکربندی که استفاده خواهد شد، مگر اینکه $HOME/.vnstatrc وجود داشته باشد. برای اطلاعات بیشتر vnstat.conf(5) را ببینید.

نمایش خلاصه ترافیک برای رابط پیش‌فرض یا چندین رابط (در صورتی که بیش از یک رابط پایش شود).
vnstat -i eth0+eth1+eth3
نمایش خلاصه ترافیک حاصل از ادغام رابط‌های eth0، eth1 و eth3.
vnstat -i eth2 --xml
خروجی دادن تمام اطلاعات مربوط به رابط eth2 در قالب xml.
vnstat --json
خروجی دادن تمام اطلاعات همه رابط‌های پایش‌شده در قالب json.
vnstat -i eth0 --setalias local
اختصاص نام مستعار «local» به رابط eth0. این اطلاعات بعداً هنگام پرس‌وجوی eth0 به‌عنوان یک برچسب قابل مشاهده خواهد بود.
vnstat -i eth2 --remove
حذف ورودی‌های پایگاه‌داده برای رابط eth2 و متوقف کردن پایش آن.

به‌روزرسانی‌ها باید حداقل به همان تناوبی اجرا شوند که رابط بتواند ترافیک کافی برای سرریز کردن شمارنده ترافیک رابط در هسته ایجاد کند. در غیر این صورت، این احتمال وجود دارد که بخشی از ترافیک ثبت نشود. در شمارنده‌های ترافیک رابط ۳۲ بیتی، حداکثر زمان میان دو به‌روزرسانی بستگی به این دارد که رابط با چه سرعتی می‌تواند 4 GiB را منتقل کند. توجه داشته باشید که هیچ تضمینی وجود ندارد که یک هسته ۶۴ بیتی برای همه رابط‌ها دارای شمارنده‌های ترافیک رابط ۶۴ بیتی باشد. زمان‌های نظری محاسبه‌شده عبارتند از:

10 Mbit: 54 دقیقه
100 Mbit: 5 دقیقه
1000 Mbit: 30 ثانیه

رابط‌های مجازی و نام‌مستعار (aliased) را نمی‌توان پایش کرد زیرا هسته اطلاعات ترافیکی برای این نوع رابط‌ها ارائه نمی‌دهد. چنین رابط‌هایی معمولاً eth0:0، eth0:1، eth0:2 و غیره نامیده می‌شوند که در آن‌ها eth0 رابط واقعی است که برای آن نام مستعار تعریف شده است.

استفاده از قالب‌های خروجی تاریخِ طولانی در صورتی که طول تاریخ از اندازه ثابت اختصاص‌یافته فراتر رود، ممکن است باعث به‌هم‌خوردن تراز ستون‌های نمایش‌داده‌شده شود.

Teemu Toivola <tst at iki dot fi>

vnstatd(8), vnstati(1), vnstat.conf(5), proc(5), ifconfig(8), units(7)

FEBRUARY 2025 version 2.13