.\" vim:ft=nroff:
.\" This Source Code Form is subject to the terms of the Mozilla Public
.\" License, v. 2.0. If a copy of the MPL was not distributed with this
.\" file, You can obtain one at https://mozilla.org/MPL/2.0/.
.\"
.\" Copyright (c) 2007-2026 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.  All rights reserved.
.\"
.Dd June 22, 2023
.Dt RABBITMQCTL 8
.Os "RabbitMQ Server"
.SH "نام (NAME)"
rabbitmqctl \- ابزاری برای مدیریت گره‌های RabbitMQ
.\" ------------------------------------------------------------------------------------------------
.Sh "خلاصه دستور (SYNOPSIS)"
.\" ------------------------------------------------------------------------------------------------
.Nm
.Op Fl q
.Op Fl s
.Op Fl l
.Op Fl n Ar node
.Op Fl t Ar timeout
.Ar command
.Op Ar command_options
.\" ------------------------------------------------------------------------------------------------
.Sh "توضیحات (DESCRIPTION)"
.\" ------------------------------------------------------------------------------------------------
RabbitMQ یک کارگزار پیام‌رسانی چندپروتکلی و متن‌باز است.
.Pp
.Nm
ابزار اصلی خط فرمان برای مدیریت یک گره سرور RabbitMQ است،
همراه با
.Cm rabbitmq-diagnostics
،
.Cm rabbitmq-upgrade
و موارد دیگر.
.Pp
این ابزار تمام اقدامات را با اتصال به گره هدف RabbitMQ
روی یک درگاه ارتباطی اختصاصی ابزار CLI و احراز هویت با استفاده
از یک راز مشترک (موسوم به فایل کوکی) انجام می‌دهد.
.Pp
در صورتی که اتصال با شکست مواجه شود، گره هدف در حال اجرا نباشد، یا
.Nm
نتواند با موفقیت در گره هدف احراز هویت کند،
اطلاعات تشخیصی نمایش داده می‌شود.

برای کسب اطلاعات بیشتر، به
.Lk https://www.rabbitmq.com/docs/cli "راهنمای ابزارهای CLI در RabbitMQ"
مراجعه کنید.
.\" ------------------------------------------------------------------------------------------------
.Sh "گزینه‌ها (OPTIONS)"
.\" ------------------------------------------------------------------------------------------------
.Bl -tag -width Ds
.It Fl n Ar node
گره پیش‌فرض
.Qq Ar rabbit@target-hostname
است، که در آن
.Ar target-hostname
میزبان محلی است.
روی میزبانی با نام
.Qq myserver.example.com ،
نام گره معمولاً
.Qq rabbit@myserver
خواهد بود (مگر اینکه
.Ev RABBITMQ_NODENAME
بازنویسی شده باشد، که در این صورت باید از
.It Fl -longnames
استفاده کنید).
خروجی
.Qq hostname -s
معمولاً نام میزبان درستی است که باید پس از علامت
.Qq @
استفاده شود.
برای جزئیات پیکربندی یک گره RabbitMQ به
.Xr rabbitmq-server 8
مراجعه کنید.
.It Fl q , -quiet
حالت خروجی بی‌صدا (quiet) انتخاب می‌شود.
هنگامی که حالت بی‌صدا فعال باشد، پیام‌های اطلاع‌رسانی کاهش می‌یابند.
.It Fl s , -silent
حالت خروجی کاملاً ساکت (silent) انتخاب می‌شود.
هنگامی که حالت ساکت فعال باشد، پیام‌های اطلاع‌رسانی کاهش یافته و سرصفحه جداول حذف می‌شوند.
.It Fl -no-table-headers
سرصفحه‌ها را برای داده‌های جدولی چاپ نمی‌کند.
.It Fl -dry-run
دستور را اجرا نمی‌کند.
فقط پیام‌های اطلاع‌رسانی را چاپ می‌کند.
.It Fl t Ar timeout , Fl -timeout Ar timeout
مهلت زمانی عملیات بر حسب ثانیه.
همه دستورها از مهلت زمانی پشتیبانی نمی‌کنند.
مقدار پیش‌فرض
.Cm infinity
است.
.It Fl l , Fl -longnames
هنگامی که کلاستر برای استفاده از نام‌های بلند گره (FQDN) پیکربندی شده است، باید مشخص شود.
برای کسب اطلاعات بیشتر، به
.Lk https://www.rabbitmq.com/docs/clustering "راهنمای کلاسترینگ RabbitMQ"
مراجعه کنید.
.It Fl -erlang-cookie Ar cookie
راز مشترک مورد استفاده برای احراز هویت در گره هدف.
ترجیحاً به جای مشخص کردن این گزینه در خط فرمان، از یک فایل محلی یا متغیر محیطی
.Ev RABBITMQ_ERLANG_COOKIE
استفاده کنید.
برای کسب اطلاعات بیشتر، به
.Lk https://www.rabbitmq.com/docs/cli "راهنمای ابزارهای CLI در RabbitMQ"
مراجعه کنید.
.El
.\" ------------------------------------------------------------------------------------------------
.Sh "دستورها (COMMANDS)"
.\" ------------------------------------------------------------------------------------------------
.Bl -tag -width Ds
.It Cm help Oo Fl l Oc Op Ar command_name
.Pp
راهنمای نحوه استفاده از تمام دستورهای موجود را چاپ می‌کند.
.Bl -tag -width Ds
.It Fl l , Fl -list-commands
تنها نحوه استفاده از دستورها را بدون توضیح پارامترها فهرست می‌کند.
.It Ar command_name
نحوه استفاده از دستور مشخص‌شده را چاپ می‌کند.
.El
.\" ------------------------------------------------------------------
.It Cm version
.Pp
نسخه ابزارهای CLI را نمایش می‌دهد.
.El
.\" ------------------------------------------------------------------
.\" ## Nodes
.\" ------------------------------------------------------------------
.Ss "گره‌ها (Nodes)"
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm await_startup
.Pp
منتظر می‌ماند تا برنامه RabbitMQ روی گره هدف راه‌اندازی شود.
.Pp
برای نمونه، جهت انتظار برای شروع به کار برنامه RabbitMQ:
.sp
.Dl rabbitmqctl await_startup
.\" ------------------------------------------------------------------
.It Cm reset
.Pp
یک گره RabbitMQ را به حالت اولیه و دست‌نخورده خود بازمی‌گرداند.
.Pp
گره را از هر کلاستری که به آن تعلق دارد حذف می‌کند، تمام داده‌ها را از
پایگاه داده مدیریتی، مانند کاربران و vhostهای پیکربندی‌شده، پاک می‌کند و
تمام پیام‌های پایدار را حذف می‌نماید.
.Pp
برای اینکه
.Cm reset
و
.Cm force_reset
موفق شوند، برنامه RabbitMQ باید متوقف شده باشد، برای نمونه با
.Cm stop_app .
.Pp
برای نمونه، جهت بازنشانی گره RabbitMQ:
.sp
.Dl rabbitmqctl reset
.\" ------------------------------------------------------------------
.It Cm rotate_logs
.Pp
به گره RabbitMQ دستور می‌دهد تا چرخش داخلی گزارش‌ها (log rotation) را انجام دهد.
.Pp
چرخش لاگ‌ها بر اساس تنظیمات ثبت وقایع مشخص‌شده در فایل پیکربندی انجام می‌شود.
عملیات چرخش ناهمگام (asynchronous) است و تضمینی وجود ندارد که پیش از بازگشت این دستور به پایان برسد.
.Pp
توجه داشته باشید در صورت چرخش خارجی گزارش‌ها (مانند استفاده از logrotate(8)) نیازی به فراخوانی این دستور نیست.
.Pp
برای نمونه، جهت آغاز چرخش گزارش‌ها:
.sp
.Dl rabbitmqctl rotate_logs
.\" ------------------------------------------------------------------
.It Cm shutdown
.Pp
گره را خاموش می‌کند، هم RabbitMQ و هم زمان‌اجرای (runtime) آن را.
این دستور مسدودکننده است و پس از خروج فرایند runtime بازمی‌گردد.
اگر RabbitMQ نتواند متوقف شود، یک کد خروج غیرصفر بازمی‌گرداند.
این دستور شناسه فرایند (OS PID) گره هدف را استنتاج می‌کند و
بنابراین تنها می‌تواند برای خاموش کردن گره‌هایی استفاده شود که روی همان میزبان
(یا به‌طور کلی‌تر، در همان سیستم‌عامل، برای نمونه در همان ماشین مجازی یا کانتینر) در حال اجرا هستند.
.Pp
برخلاف دستور stop، دستور shutdown:
.Bl -bullet
.It
برای انتظار جهت خروج فرایند runtime به یک
.Ar pid_file
نیاز ندارد
.It
اگر گره RabbitMQ در حال اجرا نباشد، کد خروج غیرصفر بازمی‌گرداند
.El
.Pp
برای نمونه، این دستور یک گره محلی RabbitMQ را که با نام گره پیش‌فرض اجرا می‌شود خاموش می‌کند:
.sp
.Dl rabbitmqctl shutdown
.\" ------------------------------------------------------------------
.It Cm start_app
.Pp
برنامه RabbitMQ را راه‌اندازی می‌کند.
.Pp
این دستور معمولاً پس از انجام سایر اقدامات مدیریتی که نیازمند متوقف بودن برنامه RabbitMQ هستند اجرا می‌شود، مانند
.Cm reset .
.Pp
برای نمونه، برای دستور دادن به گره RabbitMQ جهت راه‌اندازی برنامه RabbitMQ:
.sp
.Dl rabbitmqctl start_app
.\" ------------------------------------------------------------------
.It Cm stop Op Ar pid_file
.Pp
گره Erlang را که RabbitMQ روی آن در حال اجرا است متوقف می‌کند.
برای راه‌اندازی مجدد گره، دستورالعمل‌های بخش
.Qq Running the Server
را در
.Lk https://www.rabbitmq.com/docs/download "راهنمای نصب"
دنبال کنید.
.Pp
اگر یک
.Ar pid_file
مشخص شده باشد، همچنین منتظر می‌ماند تا فرایند مشخص‌شده در آن پایان یابد.
برای جزئیات مربوط به این فایل، به توضیحات دستور
.Cm wait
مراجعه کنید.
.Pp
برای نمونه، برای دستور دادن به گره RabbitMQ جهت پایان کار:
.sp
.Dl rabbitmqctl stop
.\" ------------------------------------------------------------------
.It Cm stop_app
.Pp
برنامه RabbitMQ را متوقف می‌کند، اما محیط زمان‌اجرا (Erlang VM) را در حال اجرا باقی می‌گذارد.
.Pp
این دستور معمولاً پیش از انجام سایر اقدامات مدیریتی که نیازمند متوقف بودن برنامه RabbitMQ هستند اجرا می‌شود، مانند
.Cm reset .
.Pp
برای نمونه، برای دستور دادن به گره RabbitMQ جهت متوقف کردن برنامه RabbitMQ:
.sp
.Dl rabbitmqctl stop_app
.\" ------------------------------------------------------------------
.It Cm wait Ar pid_file , Cm wait Fl -pid Ar pid
.Pp
منتظر راه‌اندازی برنامه RabbitMQ می‌ماند.
.Pp
این دستور منتظر می‌ماند تا برنامه RabbitMQ روی گره شروع به کار کند.
در صورت مشخص شدن
.Ar pidfile ،
منتظر ایجاد فایل pid می‌ماند، سپس منتظر فرایندی با pid مشخص‌شده در فایل pid یا آرگومان
.Fl -pid
می‌شود، و در نهایت منتظر می‌ماند تا برنامه RabbitMQ در آن فرایند راه‌اندازی شود.
اگر فرایند بدون راه‌اندازی برنامه RabbitMQ خاتمه یابد، دستور با شکست مواجه می‌شود.
.Pp
اگر فایل pid مشخص‌شده ایجاد نشود یا گره erlang در بازه زمانی
.Fl -timeout
راه‌اندازی نشود، دستور با شکست مواجه خواهد شد.
مهلت زمانی پیش‌فرض ۱۰ ثانیه است.
.Pp
یک فایل pid مناسب توسط اسکریپت
.Xr rabbitmq-server 8
ایجاد می‌شود.
به‌طور پیش‌فرض، این فایل در دایرکتوری Mnesia قرار دارد.
متغیر محیطی
.Ev RABBITMQ_PID_FILE
را برای تغییر مکان آن ویرایش کنید.
.Pp
برای نمونه، این دستور زمانی بازمی‌گردد که گره RabbitMQ راه‌اندازی شده باشد:
.sp
.Dl rabbitmqctl wait /var/run/rabbitmq/pid
.El
.\" ------------------------------------------------------------------
.\" ## Cluster Operations
.\" ------------------------------------------------------------------
.Ss "مدیریت کلاستر (Cluster management)"
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm await_online_nodes Ar count
.Pp
منتظر می‌ماند تا
.Ar count
گره به کلاستر بپیوندند.
.Pp
برای نمونه، جهت انتظار برای شروع به کار دو گره RabbitMQ:
.sp
.Dl rabbitmqctl await_online_nodes 2
.\" ------------------------------------------------------------------
.It Cm cluster_status
.Pp
تمام گره‌های موجود در کلاستر را به تفکیک نوع گره، همراه با گره‌های در حال اجرای فعلی نمایش می‌دهد.
.Pp
برای نمونه، این دستور گره‌های موجود در کلاستر را نمایش می‌دهد:
.sp
.Dl rabbitmqctl cluster_status
.\" ------------------------------------------------------------------
.It Cm force_boot
.Pp
اطمینان حاصل می‌کند که گره در نوبت بعدی حتماً شروع به کار خواهد کرد، حتی اگر آخرین گره‌ای نبوده باشد که خاموش شده است.
.Pp
به‌طور معمول هنگامی که یک کلاستر RabbitMQ را به‌طور کامل خاموش می‌کنید، نخستین گره‌ای که مجدداً راه‌اندازی می‌کنید باید آخرین گره‌ای باشد که خاموش شده است، زیرا ممکن است رخدادهایی را ثبت کرده باشد که سایر گره‌ها ندیده‌اند.
اما گاهی اوقات این امر امکان‌پذیر نیست: برای نمونه، اگر برق کل کلاستر قطع شود، ممکن است تمام گره‌ها تصور کنند که آخرین گره خاموش‌شده نبوده‌اند.
.Pp
در چنین حالتی می‌توانید هنگامی که گره خاموش است، دستور
.Cm force_boot
را فراخوانی کنید.
این کار به گره می‌گوید دفعه بعد که از آن درخواست شروع به کار کردید، بدون قید و شرط راه‌اندازی شود.
هرگونه تغییر در کلاستر پس از خاموش شدن این گره از دست خواهد رفت.
.Pp
اگر آخرین گره خاموش‌شده برای همیشه از دست رفته باشد، باید به جای این دستور از
.Cm forget_cluster_node Fl -offline
استفاده کنید، زیرا این کار تضمین می‌کند صف‌های آینه‌ای که رونوشت لیدر آن‌ها روی گره از دست رفته قرار داشته، ارتقا یابند.
.Pp
برای نمونه، این دستور گره را وادار می‌کند در نوبت بعدی راه‌اندازی منتظر گره‌های دیگر نماند:
.sp
.Dl rabbitmqctl force_boot
.\" ------------------------------------------------------------------
.It Cm force_reset Em (deprecated)
.Pp
یک گره RabbitMQ را با اجبار به حالت اولیه و دست‌نخورده خود بازمی‌گرداند.
.Pp
دستور
.Cm force_reset
با
.Cm reset
در این تفاوت دارد که گره را بدون قید و شرط، بدون توجه به وضعیت فعلی پایگاه داده مدیریتی و پیکربندی کلاستر، بازنشانی می‌کند.
این دستور تنها باید به عنوان آخرین راه‌حل در صورتی که پایگاه داده یا پیکربندی کلاستر آسیب دیده باشد، استفاده شود.
.Pp
دستور
.Cm force_reset
.Sy منسوخ شده است (deprecated) .
این دستور هنگام استفاده از ذخیره‌ساز متاداده Mnesia همچنان در دسترس است.
در ذخیره‌ساز متاداده Khepri پشتیبانی نمی‌شود.
.Pp
برای اینکه
.Cm reset
و
.Cm force_reset
موفق شوند، برنامه RabbitMQ باید متوقف شده باشد، برای نمونه با
.Cm stop_app .
.Pp
برای نمونه، جهت بازنشانی گره RabbitMQ:
.sp
.Dl rabbitmqctl force_reset
.\" ------------------------------------------------------------------
.It Cm forget_cluster_node Op Fl -offline
.Bl -tag -width Ds
.It Fl -offline
امکان حذف گره را از یک گره آفلاین فعال می‌کند.
این تنها در وضعیتی مفید است که تمام گره‌ها آفلاین باشند و آخرین گره خاموش‌شده نتواند آنلاین شود، و در نتیجه مانع از راه‌اندازی کل کلاستر گردد.
در هیچ شرایط دیگری نباید استفاده شود زیرا می‌تواند به ناسازگاری داده‌ها منجر شود.
.El
.Pp
یک گره کلاستر را از راه دور حذف می‌کند.
گره‌ای که حذف می‌شود باید آفلاین باشد، در حالی که گره‌ای که حذف از طریق آن انجام می‌شود باید آنلاین باشد، مگر هنگام استفاده از پرچم
.Fl -offline .
.Pp
هنگام استفاده از پرچم
.Fl -offline
،
.Nm
تلاش نخواهد کرد مانند حالت عادی به یک گره متصل شود؛ در عوض به‌طور موقت به خود آن گره تبدیل می‌شود تا تغییرات را اعمال کند.
این در صورتی مفید است که گره نتواند به‌طور عادی راه‌اندازی شود.
در این حالت، گره به منبع رسمی متاداده کلاستر (برای نمونه اینکه کدام صف‌ها وجود دارند) تبدیل می‌شود، حتی اگر قبلاً چنین نبوده باشد.
بنابراین در صورت امکان، این دستور را روی آخرین گره‌ای که خاموش شده است اجرا کنید.
.Pp
برای نمونه، این دستور گره
.Qq rabbit@stringer
را از گره
.Qq hare@mcnulty
حذف می‌کند:
.sp
.Dl rabbitmqctl -n hare@mcnulty forget_cluster_node rabbit@stringer
.\" ------------------------------------------------------------------
.It Cm join_cluster Ar seed-node
.Bl -tag -width Ds
.It Ar seed-node
عضو موجود در کلاستر (گره بذر / seed node) برای پیوستن به کلاستر با آن.
.El
.Pp
به گره دستور می‌دهد به عضویت کلاستری درآید که گره مشخص‌شده در آن قرار دارد.
پیش از پیوستن به کلاستر، گره بازنشانی (reset) می‌شود، بنابراین هنگام استفاده از این دستور احتیاط کنید.
برای موفقیت‌آمیز بودن این دستور، برنامه RabbitMQ باید متوقف شده باشد، برای نمونه با
.Cm stop_app .
.Pp
پس از اجرای دستور
.Cm join_cluster
، هر زمان که برنامه RabbitMQ روی گره جاری راه‌اندازی شود، تلاش خواهد کرد به گره‌هایی که در زمان خاموش شدن گره در کلاستر حضور داشتند متصل شود.
.Pp
برای خروج از یک کلاستر، گره را
.Cm reset
کنید.
همچنین می‌توانید با استفاده از دستور
.Cm forget_cluster_node
گره‌ها را از راه دور حذف نمایید.
.Pp
برای کسب اطلاعات بیشتر، به
.Lk https://www.rabbitmq.com/docs/clustering "راهنمای کلاسترینگ RabbitMQ"
مراجعه کنید.
.\" ------------------------------------------------------------------
.\" ## User management
.\" ------------------------------------------------------------------
.Ss "مدیریت کاربران (User Management)"
توجه داشته باشید که تمام دستورهای مدیریت کاربر در
.Nm
تنها می‌توانند کاربران را در پایگاه داده داخلی RabbitMQ مدیریت کنند.
کاربرانِ بک‌اندهای احراز هویت جایگزین مانند LDAP را نمی‌توان با این دستورهای
.Nm
بررسی یا مدیریت کرد.
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm add_user Ar username Ar password
.Bl -tag -width Ds
.It Ar username
نام کاربری که باید ایجاد شود.
.It Ar password
گذرواژه‌ای که کاربر ایجادشده برای ورود به کارگزار استفاده خواهد کرد.
.El
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد کاربری (غیرمدیریتی) به نام
.Qq janeway
با گذرواژه (اولیه)
.Qq changeit
ایجاد کند:
.sp
.Dl rabbitmqctl add_user janeway changeit
.\" ------------------------------------------------------------------
.It Cm authenticate_user Ar username Ar password
.Bl -tag -width Ds
.It Ar username
نام کاربر.
.It Ar password
گذرواژه کاربر.
.El
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تا کاربری به نام
.Qq janeway
را با گذرواژه
.Qq verifyit
احراز هویت کند:
.sp
.Dl rabbitmqctl authenticate_user janeway verifyit
.\" ------------------------------------------------------------------
.It Cm change_password Ar username Ar newpassword
.Bl -tag -width Ds
.It Ar username
نام کاربری که گذرواژه او باید تغییر کند.
.It Ar newpassword
گذرواژه جدید برای کاربر.
.El
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد گذرواژه کاربر به نام
.Qq janeway
را به
.Qq newpass
تغییر دهد:
.sp
.Dl rabbitmqctl change_password janeway newpass
.\" ------------------------------------------------------------------
.It Cm clear_password Ar username
.Bl -tag -width Ds
.It Ar username
نام کاربری که گذرواژه او باید پاک شود.
.El
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد گذرواژه کاربر به نام
.Qq janeway
را پاک کند:
.sp
.Dl rabbitmqctl clear_password janeway
.Pp
این کاربر اکنون نمی‌تواند با یک گذرواژه وارد سیستم شود (اما ممکن است برای نمونه از طریق SASL EXTERNAL در صورت پیکربندی، قادر به ورود باشد).
.\" ------------------------------------------------------------------
.It Cm hash_password Ar plaintext
.Bl -tag -width Ds
.It Ar plaintext
گذرواژه متنی ساده برای درهم‌سازی (هش کردن).
.El
.Pp
یک گذرواژه متن ساده را بر اساس الگوریتم درهم‌سازی رمز عبور پیکربندی‌شده فعلی هش می‌کند.
.\" ------------------------------------------------------------------
.It Cm delete_user Ar username
.Bl -tag -width Ds
.It Ar username
نام کاربری که باید حذف شود.
.El
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد کاربر به نام
.Qq janeway
را حذف کند:
.sp
.Dl rabbitmqctl delete_user janeway
.\" ------------------------------------------------------------------
.It Cm list_users
.Pp
کاربران را فهرست می‌کند.
هر سطر از نتیجه شامل نام کاربر و به دنبال آن فهرستی از تگ‌های تنظیم‌شده برای آن کاربر خواهد بود.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تمام کاربران را فهرست کند:
.sp
.Dl rabbitmqctl list_users
.\" ------------------------------------------------------------------
.It Cm set_user_tags Ar username Op Ar tag ...
.Bl -tag -width Ds
.It Ar username
نام کاربری که تگ‌های او باید تنظیم شود.
.It Ar tag
صفر، یک یا چند تگ برای تنظیم.
هرگونه تگ موجود قبلی حذف خواهد شد.
.El
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تا اطمینان حاصل کند کاربر به نام
.Qq janeway
یک مدیر (administrator) است:
.sp
.Dl rabbitmqctl set_user_tags janeway administrator
.Pp
این دستور هنگام احراز هویت کاربر از طریق پروتکل پیام‌رسانی هیچ تأثیری ندارد، اما می‌تواند برای این به کار رود
که به کاربر اجازه دهد هنگام ورود از راه‌های دیگر (برای نمونه با پلاگین مدیریت)، کاربران،
میزبان‌های مجازی (vhostها) و مجوزها را مدیریت کند.
.Pp
این دستور به کارگزار RabbitMQ دستور می‌دهد هرگونه تگ را از کاربر به نام
.Qq janeway
حذف کند:
.sp
.Dl rabbitmqctl set_user_tags janeway
.El
.\" ------------------------------------------------------------------
.\" ## Access Control
.\" ------------------------------------------------------------------
.Ss "کنترل دسترسی (Access control)"
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm clear_permissions Oo Fl p Ar vhost Oc Ar username
.Bl -tag -width Ds
.It Ar vhost
نام میزبان مجازی که دسترسی کاربر به آن باید سلب شود،
با مقدار پیش‌فرض
.Qq / .
.It Ar username
نام کاربری که دسترسی او به میزبان مجازی مشخص‌شده باید سلب شود.
.El
.Pp
مجوزهای کاربر را تنظیم می‌کند.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد دسترسی کاربر به نام
.Qq janeway
به میزبان مجازی به نام
.Qq my-vhost
را سلب کند:
.sp
.Dl rabbitmqctl clear_permissions -p my-vhost janeway
.\" ------------------------------------------------------------------
.It Cm clear_topic_permissions Oo Fl p Ar vhost Oc Ar username Oo Ar exchange Oc
.Bl -tag -width Ds
.It Ar vhost
نام میزبان مجازی که مجوزهای تاپیک در آن باید پاک شود،
با مقدار پیش‌فرض
.Qq / .
.It Ar username
نام کاربری که مجوزهای تاپیک او برای میزبان مجازی مشخص‌شده باید پاک شود.
.It Ar exchange
نام اکسچنج تاپیک برای پاک کردن مجوزهای تاپیک؛ پیش‌فرض تمام اکسچنج‌های تاپیکی است که کاربر مشخص‌شده برای آن‌ها مجوز تاپیک دارد.
.El
.Pp
مجوزهای تاپیک کاربر را پاک می‌کند.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد مجوزهای تاپیک کاربر به نام
.Qq janeway
را برای اکسچنج تاپیک
.Qq amq.topic
در میزبان مجازی به نام
.Qq my-vhost
حذف کند:
.sp
.Dl rabbitmqctl clear_topic_permissions -p my-vhost janeway amq.topic
.\" ------------------------------------------------------------------
.It Cm list_permissions Op Fl p Ar vhost
.Bl -tag -width Ds
.It Ar vhost
نام میزبان مجازی برای فهرست کردن کاربرانی که به آن دسترسی دارند، و مجوزهای آن‌ها.
مقدار پیش‌فرض
.Qq /
است.
.El
.Pp
مجوزها را در یک میزبان مجازی فهرست می‌کند.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تمام کاربرانی را که به میزبان مجازی به نام
.Qq my-vhost
دسترسی به آن‌ها اعطا شده است، و مجوزهایی که برای عملیات روی منابع در آن میزبان مجازی دارند، فهرست کند.
توجه داشته باشید که یک رشته خالی به این معناست که هیچ مجوزی اعطا نشده است:
.sp
.Dl rabbitmqctl list_permissions -p my-vhost
.\" ------------------------------------------------------------------
.It Cm list_topic_permissions Op Fl p Ar vhost
.Bl -tag -width Ds
.It Ar vhost
نام میزبان مجازی که مجوزهای تاپیک کاربران در آن باید فهرست شود.
مقدار پیش‌فرض
.Qq /
است.
.El
.Pp
مجوزهای تاپیک را در یک میزبان مجازی فهرست می‌کند.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تمام کاربرانی را که در میزبان مجازی به نام
.Qq my-vhost
مجوزهای تاپیک به آن‌ها اعطا شده است، فهرست کند:
.sp
.Dl rabbitmqctl list_topic_permissions -p my-vhost
.\" ------------------------------------------------------------------
.It Cm list_user_permissions Ar username
.Bl -tag -width Ds
.It Ar username
نام کاربری که مجوزهای او باید فهرست شود.
.El
.Pp
مجوزهای کاربر را فهرست می‌کند.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تمام میزبان‌های مجازی را که کاربر به نام
.Qq janeway
به آن‌ها دسترسی دارد، و مجوزهایی را که کاربر برای عملیات روی منابع در این میزبان‌های مجازی دارد، فهرست کند:
.sp
.Dl rabbitmqctl list_user_permissions janeway
.\" ------------------------------------------------------------------
.It Cm list_user_topic_permissions Ar username
.Bl -tag -width Ds
.It Ar username
نام کاربری که مجوزهای تاپیک او باید فهرست شود.
.El
.Pp
مجوزهای تاپیک کاربر را فهرست می‌کند.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تمام میزبان‌های مجازی را که کاربر به نام
.Qq janeway
به آن‌ها دسترسی دارد، و مجوزهای تاپیکی که کاربر در این میزبان‌های مجازی دارد، فهرست کند:
.sp
.Dl rabbitmqctl list_user_topic_permissions janeway
.\" ------------------------------------------------------------------
.It Cm list_vhosts Op Ar vhostinfoitem ...
.Pp
میزبان‌های مجازی (vhosts) را فهرست می‌کند.
.Pp
پارامتر
.Ar vhostinfoitem
برای نشان دادن اینکه کدام موارد اطلاعاتی میزبان مجازی در نتایج گنجانده شود، استفاده می‌شود.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar vhostinfoitem
می‌تواند هر مقداری از فهرست زیر را بگیرد:
.Bl -tag -width Ds
.It Cm name
نام میزبان مجازی همراه با گریز کاراکترهای غیر ASCII همانند C.
.It Cm tracing
آیا ردیابی (tracing) برای این میزبان مجازی فعال است یا خیر.
.It Cm default_queue_type
نوع صف پیش‌فرض برای این vhost.
.It Cm description
توضیحات میزبان مجازی.
.It Cm tags
تگ‌های میزبان مجازی.
.It Cm cluster_state
وضعیت میزبان مجازی در کلاستر: nodedown، running، stopped.
.El
.Pp
اگر هیچ
.Ar vhostinfoitem
مشخص نشده باشد، نام vhost نمایش داده می‌شود.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تمام میزبان‌های مجازی را فهرست کند:
.sp
.Dl rabbitmqctl list_vhosts name tracing
.\" ------------------------------------------------------------------
.It Cm set_permissions Oo Fl p Ar vhost Oc Ar user Ar conf Ar write Ar read
.Bl -tag -width Ds
.It Ar vhost
نام میزبان مجازی که دسترسی کاربر به آن باید اعطا شود،
با مقدار پیش‌فرض
.Qq / .
.It Ar user
نام کاربری که دسترسی به میزبان مجازی مشخص‌شده به او اعطا می‌شود.
.It Ar conf
یک عبارت باقاعده (regex) مطابق با نام منابعی که مجوز پیکربندی برای آن‌ها به کاربر اعطا می‌شود.
.It Ar write
یک عبارت باقاعده مطابق با نام منابعی که مجوز نوشتن برای آن‌ها به کاربر اعطا می‌شود.
.It Ar read
یک عبارت باقاعده مطابق با نام منابعی که مجوز خواندن برای آن‌ها به کاربر اعطا می‌شود.
.El
.Pp
مجوزهای کاربر را تنظیم می‌کند.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تا به کاربر به نام
.Qq janeway
دسترسی به میزبان مجازی به نام
.Qq my-vhost
را اعطا کند، با مجوزهای پیکربندی روی تمام منابعی که نام آن‌ها با
.Qq janeway-
آغاز می‌شود، و مجوزهای نوشتن و خواندن روی تمام منابع:
.sp
.Dl rabbitmqctl set_permissions -p my-vhost janeway Qo ^janeway-.* Qc Qo .* Qc Qq .*
.\" ------------------------------------------------------------------
.It Cm set_permissions_globally Ar username Ar conf Ar write Ar read
.Bl -tag -width Ds
.It Ar username
نام کاربری که دسترسی به میزبان مجازی به او اعطا می‌شود.
.It Ar conf
یک عبارت باقاعده مطابق با نام منابعی که مجوز پیکربندی برای آن‌ها به کاربر اعطا می‌شود.
.It Ar write
یک عبارت باقاعده مطابق با نام منابعی که مجوز نوشتن برای آن‌ها به کاربر اعطا می‌شود.
.It Ar read
یک عبارت باقاعده مطابق با نام منابعی که مجوز خواندن برای آن‌ها به کاربر اعطا می‌شود.
.El
.Pp
مجوزهای کاربر را در تمام vhostها تنظیم می‌کند.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تا به کاربر به نام
.Qq janeway
دسترسی به تمام میزبان‌های مجازی را با مجوزهای پیکربندی روی تمام منابعی که نام آن‌ها با
.Qq janeway-
آغاز می‌شود، و مجوزهای نوشتن و خواندن روی تمام منابع اعطا کند:
.sp
.Dl rabbitmqctl set_permissions_globally janeway Qo ^janeway-.* Qc Qo .* Qc Qq .*
.\" ------------------------------------------------------------------
.It Cm set_topic_permissions Oo Fl p Ar vhost Oc Ar user Ar exchange Ar write Ar read
.Bl -tag -width Ds
.It Ar vhost
نام میزبان مجازی که دسترسی کاربر به آن باید اعطا شود،
با مقدار پیش‌فرض
.Qq / .
.It Ar user
نام کاربری که مجوزها برای او در میزبان مجازی هدف اعمال می‌شود.
.It Ar exchange
نام اکسچنج تاپیک که بررسی مجوز روی آن اعمال خواهد شد.
.It Ar write
یک عبارت باقاعده مطابق با کلید مسیریابی (routing key) پیام منتشرشده.
.It Ar read
یک عبارت باقاعده مطابق با کلید مسیریابی پیام مصرف‌شده.
.El
.Pp
مجوزهای تاپیک کاربر را تنظیم می‌کند.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد به کاربر به نام
.Qq janeway
اجازه دهد پیام‌هایی را که از طریق اکسچنج
.Qq amq.topic
در میزبان مجازی
.Qq my-vhost
عبور می‌کنند، با کلید مسیریابی که با
.Qq janeway-
آغاز می‌شود، منتشر و مصرف کند:
.sp
.Dl rabbitmqctl set_topic_permissions -p my-vhost janeway amq.topic Qo ^janeway-.* Qc Qo ^janeway-.* Qc
.Pp
مجوزهای تاپیک از جایگزینی متغیر برای متغیرهای زیر پشتیبانی می‌کنند:
username، vhost و client_id. توجه داشته باشید که client_id تنها هنگام استفاده از MQTT جایگزین می‌شود.
مثال قبلی را می‌توان با استفاده از
.Qq ^{username}-.*
عمومی‌تر کرد:
.sp
.Dl rabbitmqctl set_topic_permissions -p my-vhost janeway amq.topic Qo ^{username}-.* Qc Qo ^{username}-.* Qc
.El
.\" ------------------------------------------------------------------
.\" ## Monitoring and Observability
.\" ------------------------------------------------------------------
.Ss "پایش، مشاهده‌پذیری و بررسی‌های سلامت (Monitoring, observability and health checks)"
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm environment
.Pp
نام و مقدار هر متغیر را در محیط برنامه (application environment) برای هر برنامه در حال اجرا نمایش می‌دهد.
.\" ------------------------------------------------------------------
.It Cm list_bindings Oo Fl p Ar vhost Oc Op Ar bindinginfoitem ...
.Pp
جزئیات پیوندها (bindings) را برمی‌گرداند.
به‌طور پیش‌فرض، پیوندهای میزبان مجازی
.Qq /
برگردانده می‌شوند.
پرچم
.Fl p
می‌تواند برای بازنویسی این مقدار پیش‌فرض استفاده شود.
.Pp
پارامتر
.Ar bindinginfoitem
برای نشان دادن اینکه کدام موارد اطلاعاتی پیوند در نتایج گنجانده شود، استفاده می‌شود.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar bindinginfoitem
می‌تواند هر مقداری از فهرست زیر را بگیرد:
.Bl -tag -width Ds
.It Cm source_name
نام منبع پیام‌هایی که پیوند به آن متصل است.
همراه با گریز کاراکترهای غیر ASCII همانند C.
.It Cm source_kind
نوع منبع پیام‌هایی که پیوند به آن متصل است.
در حال حاضر همیشه exchange است.
همراه با گریز کاراکترهای غیر ASCII همانند C.
.It Cm destination_name
نام مقصد پیام‌هایی که پیوند به آن متصل است.
همراه با گریز کاراکترهای غیر ASCII همانند C.
.It Cm destination_kind
نوع مقصد پیام‌هایی که پیوند به آن متصل است.
همراه با گریز کاراکترهای غیر ASCII همانند C.
.It Cm routing_key
کلید مسیریابی پیوند همراه با گریز کاراکترهای غیر ASCII همانند C.
.It Cm arguments
آرگومان‌های پیوند.
.El
.Pp
اگر هیچ
.Ar bindinginfoitem
مشخص نشده باشد، تمام موارد بالا نمایش داده می‌شوند.
.Pp
برای نمونه، این دستور نام اکسچنج و نام صف پیوندها را در میزبان مجازی به نام
.Qq my-vhost
نمایش می‌دهد:
.sp
.Dl rabbitmqctl list_bindings -p my-vhost exchange_name queue_name
.\" ------------------------------------------------------------------
.It Cm list_channels Op Ar channelinfoitem ...
.Pp
اطلاعات مربوط به تمام کانال‌های فعلی، یعنی ظرف‌های منطقی مجری بیشتر دستورهای AMQP را برمی‌گرداند.
این شامل کانال‌هایی است که بخشی از اتصالات عادی AMQP هستند و کانال‌هایی که توسط افزونه‌های گوناگون و سایر الحاقات ایجاد شده‌اند.
.Pp
پارامتر
.Ar channelinfoitem
برای نشان دادن اینکه کدام موارد اطلاعاتی کانال در نتایج گنجانده شود، استفاده می‌شود.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar channelinfoitem
می‌تواند هر مقداری از فهرست زیر را بگیرد:
.Bl -tag -width Ds
.It Cm pid
شناسه فرایند Erlang مرتبط با اتصال.
.It Cm connection
شناسه فرایند Erlang مرتبط با اتصالی که کانال به آن تعلق دارد.
.It Cm name
نام خوانا برای کانال.
.It Cm number
شماره کانال که آن را به‌طور یکتا درون یک اتصال مشخص می‌کند.
.It Cm user
نام کاربری مرتبط با کانال.
.It Cm vhost
میزبان مجازی که کانال در آن فعالیت می‌کند.
.It Cm transactional
در صورتی که کانال در حالت تراکنشی باشد مقدار True، و در غیر این صورت False است.
.It Cm confirm
در صورتی که کانال در حالت تایید (confirm) باشد مقدار True، و در غیر این صورت False است.
.It Cm consumer_count
تعداد مصرف‌کنندگان منطقی AMQP که پیام‌ها را از طریق کانال دریافت می‌کنند.
.It Cm messages_unacknowledged
تعداد پیام‌های تحویل‌داده‌شده از طریق این کانال که هنوز تایید (ack) نشده‌اند.
.It Cm messages_uncommitted
تعداد پیام‌های دریافتی در یک تراکنش که هنوز کامیت نشده است.
.It Cm acks_uncommitted
تعداد تاییدهای دریافتی در یک تراکنش که هنوز کامیت نشده است.
.It Cm messages_unconfirmed
تعداد پیام‌های منتشرشده که هنوز تایید دریافت نکرده‌اند.
روی کانال‌هایی که در حالت تایید (confirm) نیستند، این مقدار ۰ باقی می‌ماند.
.It Cm prefetch_count
حد پیش‌واکشی QoS برای مصرف‌کنندگان جدید، در صورت نامحدود بودن ۰ است.
.El
.Pp
اگر هیچ
.Ar channelinfoitem
مشخص نشده باشد، موارد pid، user، consumer_count و messages_unacknowledged در نظر گرفته می‌شوند.
.Pp
برای نمونه، این دستور فرایند اتصال و تعداد پیام‌های تاییدنشده را برای هر کانال نمایش می‌دهد:
.sp
.Dl rabbitmqctl list_channels connection messages_unacknowledged
.\" ------------------------------------------------------------------
.It Cm list_ciphers
.Pp
مجموعه‌های رمزنگاری (cipher suites) پشتیبانی‌شده توسط دستورهای کدگذاری را فهرست می‌کند.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تمام مجموعه‌های رمزنگاری پشتیبانی‌شده توسط دستورهای کدگذاری را فهرست کند:
.sp
.Dl rabbitmqctl list_ciphers
.\" ------------------------------------------------------------------
.It Cm list_connections Op Ar connectioninfoitem ...
.Pp
آمار اتصالات TCP/IP را برمی‌گرداند.
.Pp
پارامتر
.Ar connectioninfoitem
برای نشان دادن اینکه کدام موارد اطلاعاتی اتصال در نتایج گنجانده شود، استفاده می‌شود.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar connectioninfoitem
می‌تواند هر مقداری از فهرست زیر را بگیرد:
.Bl -tag -width Ds
.It Cm pid
شناسه فرایند Erlang مرتبط با اتصال.
.It Cm name
نام خوانا برای اتصال.
.It Cm port
درگاه سرور.
.It Cm host
نام میزبان سرور به‌دست‌آمده از طریق DNS معکوس، یا آدرس IP آن در صورتی که DNS معکوس ناموفق بوده یا غیرفعال شده باشد.
.It Cm peer_port
درگاه همتا (peer).
.It Cm peer_host
نام میزبان همتا به‌دست‌آمده از طریق DNS معکوس، یا آدرس IP آن در صورتی که DNS معکوس ناموفق بوده یا فعال نشده باشد.
.It Cm ssl
یک مقدار بولی که نشان می‌دهد آیا اتصال با SSL امن شده است یا خیر.
.It Cm ssl_protocol
پروتکل SSL (برای نمونه
.Qq tlsv1 ) .
.It Cm ssl_key_exchange
الگوریتم تبادل کلید SSL (برای نمونه
.Qq rsa ) .
.It Cm ssl_cipher
الگوریتم رمزنگاری SSL (برای نمونه
.Qq aes_256_cbc ) .
.It Cm ssl_hash
تابع درهم‌سازی SSL (برای نمونه
.Qq sha ) .
.It Cm peer_cert_subject
موضوع (subject) گواهی SSL همتا در قالب RFC4514.
.It Cm peer_cert_issuer
صادرکننده (issuer) گواهی SSL همتا در قالب RFC4514.
.It Cm peer_cert_serial_number
شماره سریال گواهی SSL همتا، در قالب هگزادسیمال.
.It Cm peer_cert_validity
دوره‌ای که گواهی SSL همتا طی آن معتبر است.
.It Cm state
وضعیت اتصال؛ یکی از موارد:
.Bl -bullet -compact
.It
starting
.It
tuning
.It
opening
.It
running
.It
flow
.It
blocking
.It
blocked
.It
closing
.It
closed
.El
.It Cm channels
تعداد کانال‌هایی که از این اتصال استفاده می‌کنند.
.It Cm protocol
نسخه پروتکل AMQP در حال استفاده -- در حال حاضر یکی از موارد:
.Bl -bullet -compact
.It
{0,9,1}
.It
{0,8,0}
.El
.Pp
توجه داشته باشید اگر یک کلاینت اتصال AMQP 0-9 را درخواست کند، ما با آن مانند AMQP 0-9-1 رفتار می‌کنیم.
.It Cm auth_mechanism
مکانیزم احراز هویت SASL استفاده‌شده، مانند
.Qq PLAIN .
.It Cm user
نام کاربری مرتبط با اتصال.
.It Cm vhost
نام میزبان مجازی همراه با گریز کاراکترهای غیر ASCII همانند C.
.It Cm timeout
مهلت زمانی اتصال / فاصله زمانی توافق‌شده برای ضربان قلب (heartbeat)، بر حسب ثانیه.
.It Cm frame_max
حداکثر اندازه فریم (بر حسب بایت).
.It Cm channel_max
حداکثر تعداد کانال‌ها روی این اتصال.
.It Cm client_properties
ویژگی‌های اطلاعاتی ارسال‌شده توسط کلاینت در طول برقراری اتصال.
.It Cm recv_oct
اکتت‌های دریافت شده.
.It Cm recv_cnt
بسته‌های دریافت شده.
.It Cm send_oct
اکتت‌های ارسال شده.
.It Cm send_cnt
بسته‌های ارسال شده.
.It Cm send_pend
اندازه صف ارسال.
.It Cm connected_at
تاریخ و زمانی که این اتصال برقرار شده است، به صورت یک برچسب زمانی (timestamp).
.El
.Pp
اگر هیچ
.Ar connectioninfoitem
مشخص نشده باشد، موارد user، peer host، peer port، مدت زمان پس از کنترل جریان (time since flow control) و وضعیت مسدود شدن حافظه نمایش داده می‌شوند.
.Pp
برای نمونه، این دستور اندازه صف ارسال و درگاه سرور را برای هر اتصال نمایش می‌دهد:
.sp
.Dl rabbitmqctl list_connections send_pend port
.\" ------------------------------------------------------------------
.It Cm list_consumers Op Fl p Ar vhost
.Pp
مصرف‌کنندگان را فهرست می‌کند، یعنی اشتراک‌ها در جریان پیام‌های یک صف.
هر سطر چاپ‌شده، که با کاراکترهای تب جدا شده است، نشان‌دهنده نام صف مشترک‌شده، شناسه فرایند کانالی که اشتراک از طریق آن ایجاد شده و مدیریت می‌شود، تگ مصرف‌کننده که اشتراک را به‌طور یکتا درون یک کانال مشخص می‌کند، یک مقدار بولی که نشان می‌دهد آیا تاییدیه (acknowledgement) برای پیام‌های تحویل‌داده‌شده به این مصرف‌کننده انتظار می‌رود، یک عدد صحیح که حد پیش‌واکشی را نشان می‌دهد (که ۰ به معنای
.Qq none
است)، و هرگونه آرگومان برای این مصرف‌کننده است.
.\" ------------------------------------------------------------------
.It Cm list_exchanges Oo Fl p Ar vhost Oc Op Ar exchangeinfoitem ...
.Pp
جزئیات اکسچنج را برمی‌گرداند.
در صورت عدم وجود پرچم
.Fl p ،
جزئیات اکسچنج‌های میزبان مجازی
.Qq /
برگردانده می‌شود.
پرچم
.Fl p
می‌تواند برای بازنویسی این مقدار پیش‌فرض استفاده شود.
.Pp
پارامتر
.Ar exchangeinfoitem
برای نشان دادن اینکه کدام موارد اطلاعاتی اکسچنج در نتایج گنجانده شود، استفاده می‌شود.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar exchangeinfoitem
می‌تواند هر مقداری از فهرست زیر را بگیرد:
.Bl -tag -width Ds
.It Cm name
نام اکسچنج همراه با گریز کاراکترهای غیر ASCII همانند C.
.It Cm type
نوع اکسچنج، مانند:
.Bl -bullet -compact
.It
direct
.It
topic
.It
headers
.It
fanout
.El
.It Cm durable
آیا اکسچنج پس از راه‌اندازی مجدد سرور باقی می‌ماند یا خیر.
.It Cm auto_delete
آیا هنگامی که اکسچنج دیگر مورد استفاده قرار نمی‌گیرد به‌طور خودکار حذف خواهد شد یا خیر.
.It Cm internal
آیا اکسچنج داخلی است، به این معنی که کلاینت‌ها نمی‌توانند مستقیماً روی آن پیام منتشر کنند.
.It Cm arguments
آرگومان‌های اکسچنج.
.It Cm policy
نام پالیسی (policy) اعمال‌شده روی اکسچنج.
.El
.Pp
اگر هیچ
.Ar exchangeinfoitem
مشخص نشده باشد، نام و نوع اکسچنج نمایش داده می‌شود.
.Pp
برای نمونه، این دستور نام و نوع هر اکسچنج از میزبان مجازی به نام
.Qq my-vhost
را نمایش می‌دهد:
.sp
.Dl rabbitmqctl list_exchanges -p my-vhost name type
.\" ------------------------------------------------------------------
.It Cm list_hashes
.Pp
توابع درهم‌سازی پشتیبانی‌شده توسط دستورهای کدگذاری را فهرست می‌کند.
.Pp
برای نمونه، این دستور به کارگزار RabbitMQ دستور می‌دهد تمام توابع درهم‌سازی پشتیبانی‌شده توسط دستورهای کدگذاری را فهرست کند:
.sp
.Dl rabbitmqctl list_hashes
.\" ------------------------------------------------------------------
.It Cm list_queues Oo Fl p Ar vhost Oc Oo Fl -offline | Fl -online | Fl -local Oc Op Ar queueinfoitem ...
.Pp
جزئیات صف را برمی‌گرداند.
در صورت عدم وجود پرچم
.Fl p ،
جزئیات صف‌های میزبان مجازی
.Qq /
برگردانده می‌شود.
پرچم
.Fl p
می‌تواند برای بازنویسی این مقدار پیش‌فرض استفاده شود.
.Pp
صف‌های نمایش داده شده را می‌توان بر اساس وضعیت یا مکان آن‌ها با استفاده از یکی از گزینه‌های ناسازگار با هم (مانعة‌الجمع) زیر فیلتر کرد:
.Bl -tag -width Ds
.It Fl -offline
تنها صف‌های پایداری را فهرست می‌کند که در حال حاضر در دسترس نیستند (به‌طور مشخص‌تر، گره لیدر آن‌ها در دسترس نیست).
.It Fl -online
صف‌هایی را که در حال حاضر در دسترس هستند (گره لیدر آن‌ها در دسترس است) فهرست می‌کند.
.It Fl -local
تنها صف‌هایی را فهرست می‌کند که رونوشت لیدر آن‌ها روی گره فعلی قرار دارد.
.El
.Pp
پارامتر
.Ar queueinfoitem
برای نشان دادن اینکه کدام موارد اطلاعاتی صف در نتایج گنجانده شود، استفاده می‌شود.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar queueinfoitem
می‌تواند هر مقداری از فهرست زیر را بگیرد:
.Bl -tag -width Ds
.It Cm name
نام صف همراه با گریز کاراکترهای غیر ASCII همانند C.
.It Cm durable
آیا صف پس از راه‌اندازی مجدد سرور باقی می‌ماند یا خیر.
.It Cm auto_delete
آیا هنگامی که صف دیگر مورد استفاده قرار نمی‌گیرد به‌طور خودکار حذف خواهد شد یا خیر.
.It Cm arguments
آرگومان‌های صف.
.It Cm policy
نام پالیسی کاربر که روی صف اعمال شده است.
.It Cm operator_policy
نام پالیسی اپراتور که روی صف اعمال شده است.
.It Cm effective_policy_definition
تعریف پالیسی مؤثر برای صف: ترکیب تعاریف پالیسی کاربر و اپراتور.
.It Cm pid
شناسه فرایند Erlang مربوط به صف.
.It Cm owner_pid
شناسه فرایند Erlang مربوط به اتصالی که مالک انحصاری صف است.
اگر صف غیراختصاصی باشد، خالی است.
.It Cm exclusive
در صورتی که صف اختصاصی باشد (یعنی owner_pid داشته باشد) مقدار True، و در غیر این صورت False است.
.It Cm exclusive_consumer_pid
شناسه فرایند Erlang که نشان‌دهنده کانال مصرف‌کننده انحصاری مشترک‌شده در این صف است.
اگر مصرف‌کننده انحصاری وجود نداشته باشد، خالی است.
.It Cm exclusive_consumer_tag
تگ مصرف‌کننده مربوط به مصرف‌کننده انحصاری مشترک‌شده در این صف.
اگر مصرف‌کننده انحصاری وجود نداشته باشد، خالی است.
.It Cm messages_ready
تعداد پیام‌های آماده برای تحویل به کلاینت‌ها.
.It Cm messages_unacknowledged
تعداد پیام‌های تحویل‌داده‌شده به کلاینت‌ها که هنوز تایید (ack) نشده‌اند.
.It Cm messages
مجموع پیام‌های آماده و تاییدنشده (عمق صف).
.It Cm messages_ready_ram
تعداد پیام‌ها از messages_ready که در حافظه رم مقیم هستند.
.It Cm messages_unacknowledged_ram
تعداد پیام‌ها از messages_unacknowledged که در حافظه رم مقیم هستند.
.It Cm messages_ram
تعداد کل پیام‌هایی که در حافظه رم مقیم هستند.
.It Cm messages_persistent
تعداد کل پیام‌های پایدار در صف (برای صف‌های گذرا / transient همیشه ۰ خواهد بود).
.It Cm message_bytes
مجموع اندازه تمام بدنه پیام‌ها در صف.
این مقدار شامل ویژگی‌های پیام (از جمله سرصفحه‌ها) یا هرگونه بار اضافی (overhead) نمی‌شود.
.It Cm message_bytes_ready
مانند
.Cm message_bytes
اما تنها آن دسته از پیام‌هایی را که آماده تحویل به کلاینت‌ها هستند می‌شمارد.
.It Cm message_bytes_unacknowledged
مانند
.Cm message_bytes
اما تنها آن دسته از پیام‌هایی را که به کلاینت‌ها تحویل داده شده ولی هنوز تایید نشده‌اند می‌شمارد.
.It Cm message_bytes_ram
مانند
.Cm message_bytes
اما تنها پیام‌هایی را که در حال حاضر در رم نگهداری می‌شوند می‌شمارد.
.It Cm message_bytes_persistent
مانند
.Cm message_bytes
اما تنها پیام‌هایی را که پایدار هستند می‌شمارد.
.It Cm head_message_timestamp
ویژگی برچسب زمانی نخستین پیام در صف، در صورت وجود.
برچسب زمانی پیام‌ها تنها زمانی ظاهر می‌شود که در وضعیت مقیم در حافظه (paged-in) باشند.
.It Cm disk_reads
تعداد دفعاتی که از زمان راه‌اندازی این صف، پیام‌ها توسط آن از دیسک خوانده شده‌اند.
.It Cm disk_writes
تعداد دفعاتی که از زمان راه‌اندازی این صف، پیام‌ها توسط آن بر روی دیسک نوشته شده‌اند.
.It Cm consumers
تعداد مصرف‌کنندگان.
.It Cm consumer_utilisation
کسری از زمان (بین ۰.۰ و ۱.۰) که صف قادر است فوراً پیام‌ها را به مصرف‌کنندگان تحویل دهد.
در صورتی که مصرف‌کنندگان به دلیل ازدحام شبکه یا سقف پیش‌واکشی (prefetch count) محدود شده باشند، این مقدار می‌تواند کمتر از ۱.۰ باشد.
.It Cm memory
بایت‌های حافظه تخصیص‌یافته توسط زمان‌اجرا برای صف، از جمله پشته (stack)، هیپ (heap) و ساختارهای داخلی.
.It Cm mirror_pids
اگر صف به صورت آینه‌ای باشد، این گزینه شناسه‌های آینه‌ها (رونوشت‌های پیرو / follower replicas) را فهرست می‌کند.
برای کسب اطلاعات بیشتر، به
.Lk https://www.rabbitmq.com/docs/3.13/ha "راهنمای آینه‌سازی در RabbitMQ"
مراجعه کنید.
.It Cm synchronised_mirror_pids
اگر صف به صورت آینه‌ای باشد، این گزینه شناسه‌های آینه‌هایی (رونوشت‌های پیرو) را ارائه می‌دهد که با رونوشت لیدر همگام هستند.
برای کسب اطلاعات بیشتر، به
.Lk https://www.rabbitmq.com/docs/3.13/ha "راهنمای آینه‌سازی در RabbitMQ"
مراجعه کنید.
.It Cm state
وضعیت صف.
به‌طور معمول
.Qq running
است، اما در صورتی که صف در حال همگام‌سازی باشد ممکن است
.Qq Bro syncing, Ar message_count Brc
باشد.
.Pp
صف‌هایی که روی گره‌های کلاسترِ در حال حاضر خاموش قرار دارند، با وضعیت
.Qq down
نشان داده خواهند شد
(و بیشتر موارد دیگر
.Ar queueinfoitem
در دسترس نخواهند بود).
.It Cm type
نوع صف، یکی از موارد: quorum، stream، classic.
.El
.Pp
اگر هیچ
.Ar queueinfoitem
مشخص نشده باشد، نام و عمق صف نمایش داده می‌شود.
.Pp
برای نمونه، این دستور عمق و تعداد مصرف‌کنندگان را برای هر صف از میزبان مجازی به نام
.Qq my-vhost
نمایش می‌دهد:
.sp
.Dl rabbitmqctl list_queues -p my-vhost messages consumers
.\" ------------------------------------------------------------------
.It Cm list_unresponsive_queues Oo Fl -local Oc Oo Fl -queue-timeout Ar seconds Oc Oo Ar queueinfoitem ... Oc Op Fl -no-table-headers
.Pp
رونوشت‌های لیدر صف را برای پاسخ‌دهی در مهلت زمانی مشخص‌شده آزمایش می‌کند. صف‌هایی را که به موقع پاسخ نداده‌اند فهرست می‌کند.
.Pp
صف‌های نمایش داده شده را می‌توان بر اساس وضعیت یا مکان آن‌ها با استفاده از یکی از گزینه‌های ناسازگار با هم (مانعة‌الجمع) زیر فیلتر کرد:
.Bl -tag -width Ds
.It Fl -all
تمام صف‌ها را فهرست می‌کند.
.It Fl -local
تنها صف‌هایی را فهرست می‌کند که رونوشت لیدر آن‌ها روی گره فعلی قرار دارد.
.El
.Pp
پارامتر
.Ar queueinfoitem
برای نشان دادن اینکه کدام موارد اطلاعاتی صف در نتایج گنجانده شود، استفاده می‌شود.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar queueinfoitem
می‌تواند هر مقداری از فهرست زیر را بگیرد:
.Bl -tag -width Ds
.It Cm name
نام صف همراه با گریز کاراکترهای غیر ASCII همانند C.
.It Cm durable
آیا صف باید پس از راه‌اندازی مجدد سرور باقی بماند یا خیر.
.It Cm auto_delete
آیا هنگامی که تمام پیوندهای صریح صف حذف شوند، صف به‌طور خودکار حذف خواهد شد یا خیر.
.It Cm arguments
آرگومان‌های صف.
.It Cm policy
نام پالیسی مؤثر برای صف.
.It Cm pid
شناسه فرایند Erlang رونوشت لیدر.
.It Cm recoverable_mirrors
شناسه‌های فرایند Erlang رونوشت‌های آینه‌ای که قابل دستیابی (در دسترس) تلقی می‌شوند.
.It Cm type
نوع صف، یکی از موارد: quorum، stream، classic.
.El
.Pp
برای نمونه، این دستور تنها صف‌های بدون پاسخی را فهرست می‌کند که رونوشت لیدر آن‌ها روی گره هدف میزبانی شده است:
.Sp
.Dl rabbitmqctl list_unresponsive_queues --local name
.\" ------------------------------------------------------------------
.It Cm ping
.Pp
بررسی می‌کند که فرایند سیستم‌عامل گره فعال باشد، در EPMD ثبت شده باشد، و ابزارهای CLI بتوانند در آن احراز هویت شوند.
.Pp
نمونه:
.Dl rabbitmqctl ping -n rabbit@hostname
.\" ------------------------------------------------------------------
.It Cm report
.Pp
یک گزارش وضعیت سرور شامل الحاق تمام اطلاعات وضعیت سرور برای مقاصد پشتیبانی تولید می‌کند.
هنگام همراه کردن با یک درخواست پشتیبانی، خروجی باید به یک فایل هدایت شود.
.Pp
برای نمونه، این دستور یک گزارش سرور ایجاد می‌کند که ممکن است به ایمیل درخواست پشتیبانی پیوست شود:
.sp
.Dl rabbitmqctl report > server_report.txt
.\" ------------------------------------------------------------------
.It Cm schema_info Oo Fl -no-table-headers Oc Op Ar column ...
.Pp
جداول پایگاه داده اسکِما و ویژگی‌های آن‌ها را فهرست می‌کند.
.Pp
برای نمونه، این دستور نام جداول و رونوشت‌های فعال آن‌ها را فهرست می‌کند:
.sp
.Dl rabbitmqctl schema_info name active_replicas
.\" ------------------------------------------------------------------
.It Cm status
.Pp
اطلاعات وضعیت کارگزار را نمایش می‌دهد، مانند برنامه‌های در حال اجرا روی گره فعلی Erlang،
نسخه‌های RabbitMQ و Erlang، نام سیستم‌عامل، و آمار حافظه و توصیف‌کننده‌های فایل.
(برای اطلاع از اینکه کدام گره‌ها کلاستر شده و در حال اجرا هستند، به دستور
.Cm cluster_status
مراجعه کنید.)
.Pp
برای نمونه، این دستور اطلاعات مربوط به کارگزار RabbitMQ را نمایش می‌دهد:
.sp
.Dl rabbitmqctl status
.El
.\" ------------------------------------------------------------------
.\" ## Runtime Parameters and Policies
.\" ------------------------------------------------------------------
.Ss "پارامترهای زمان اجرا و خط‌مشی‌ها (Runtime Parameters and Policies)"
برخی از ویژگی‌های RabbitMQ (مانند افزونه Federation) توسط
.Em پارامترهای
پویای سراسر کلاستر کنترل می‌شوند.
دو نوع پارامتر وجود دارد: پارامترهای محدود به یک میزبان مجازی و پارامترهای سراسری.
هر پارامتر محدود به vhost شامل یک نام مؤلفه، یک نام و یک مقدار است.
نام مؤلفه و نام رشته هستند و مقدار یک سند معتبر JSON است.
یک پارامتر سراسری شامل یک نام و مقدار است.
نام یک رشته و مقدار یک ساختار داده اختیاری Erlang است.
پارامترها را می‌توان تنظیم، پاک و فهرست کرد.
به طور کلی، برای مشاهده نحوه تنظیم پارامترها باید به مستندات ویژگی مورد نظر مراجعه کنید.
.Pp
خط‌مشی‌ها (Policies) ویژگی‌ای هستند که بر روی پارامترهای زمان اجرا ساخته شده‌اند.
خط‌مشی‌ها برای کنترل و تغییر رفتار صف‌ها و مبادله‌ها در سطح کلاستر استفاده می‌شوند.
خط‌مشی‌ها در یک vhost مشخص اعمال می‌شوند و شامل نام، الگو، تعریف و یک اولویت اختیاری هستند.
خط‌مشی‌ها را می‌توان تنظیم، پاک و فهرست کرد.
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm clear_global_parameter Ar name
.Pp
یک پارامتر زمان اجرای سراسری را پاک می‌کند.
این دستور شبیه به
.Cm clear_parameter
است، اما جفت کلید-مقدار به یک میزبان مجازی متصل نیست.
.Bl -tag -width Ds
.It Ar name
نام پارامتر زمان اجرای سراسری که پاک می‌شود.
.El
.Pp
برای مثال، این دستور پارامتر زمان اجرای سراسری
.Qq mqtt_default_vhosts
را پاک می‌کند:
.sp
.Dl rabbitmqctl clear_global_parameter mqtt_default_vhosts
.\" ------------------------------------------------------------------
.It Cm clear_parameter Oo Fl p Ar vhost Oc Ar component_name Ar key
.Pp
یک پارامتر را پاک می‌کند.
.Bl -tag -width Ds
.It Ar component_name
نام مؤلفه‌ای که پارامتر آن پاک می‌شود.
.It Ar name
نام پارامتری که پاک می‌شود.
.El
.Pp
برای مثال، این دستور پارامتر
.Qq node01
را برای مؤلفه
.Qq federation-upstream
در میزبان مجازی پیش‌فرض پاک می‌کند:
.sp
.Dl rabbitmqctl clear_parameter federation-upstream node01
.\" ------------------------------------------------------------------
.It Cm list_global_parameters
.Pp
تمام پارامترهای زمان اجرای سراسری را فهرست می‌کند.
این دستور شبیه به
.Cm list_parameters
است، اما پارامترهای زمان اجرای سراسری به هیچ میزبان مجازی متصل نیستند.
.Pp
برای مثال، این دستور تمام پارامترهای سراسری را فهرست می‌کند:
.sp
.Dl rabbitmqctl list_global_parameters
.\" ------------------------------------------------------------------
.It Cm list_parameters Op Fl p Ar vhost
.Pp
تمام پارامترهای یک میزبان مجازی را فهرست می‌کند.
.Pp
برای مثال، این دستور تمام پارامترها را در میزبان مجازی پیش‌فرض فهرست می‌کند:
.sp
.Dl rabbitmqctl list_parameters
.\" ------------------------------------------------------------------
.It Cm set_global_parameter Ar name Ar value
.Pp
یک پارامتر زمان اجرای سراسری را تنظیم می‌کند.
این دستور شبیه به
.Cm set_parameter
است، اما جفت کلید-مقدار به یک میزبان مجازی متصل نیست.
.Bl -tag -width Ds
.It Ar name
نام پارامتر زمان اجرای سراسری که تنظیم می‌شود.
.It Ar value
مقدار پارامتر زمان اجرای سراسری، به صورت یک سند JSON.
در اکثر پوسته‌ها بسیار محتمل است که نیاز به نقل‌قول کردن آن داشته باشید.
.El
.Pp
برای مثال، این دستور پارامتر زمان اجرای سراسری
.Qq mqtt_default_vhosts
را روی سند JSON {"O=client,CN=guest":"/"} تنظیم می‌کند:
.sp
.Dl rabbitmqctl set_global_parameter mqtt_default_vhosts '{"O=client,CN=guest":"/"}'
.\" ------------------------------------------------------------------
.It Cm set_parameter Oo Fl p Ar vhost Oc Ar component_name Ar name Ar value
.Pp
یک پارامتر را تنظیم می‌کند.
.Bl -tag -width Ds
.It Ar component_name
نام مؤلفه‌ای که پارامتر برای آن تنظیم می‌شود.
.It Ar name
نام پارامتری که تنظیم می‌شود.
.It Ar value
مقدار پارامتر، به صورت یک سند JSON.
در اکثر پوسته‌ها بسیار محتمل است که نیاز به نقل‌قول کردن آن داشته باشید.
.El
.Pp
برای مثال، این دستور پارامتر
.Qq node01
را برای مؤلفه
.Qq federation-upstream
در میزبان مجازی پیش‌فرض روی JSON زیر تنظیم می‌کند:
.Qq guest :
.sp
.Dl rabbitmqctl set_parameter federation-upstream node01 '{"uri":"amqp://user:password@server/%2F","ack-mode":"on-publish"}'
.\" ------------------------------------------------------------------
.It Cm list_policies Op Fl p Ar vhost
.Pp
تمام خط‌مشی‌های یک میزبان مجازی را فهرست می‌کند.
.Pp
برای مثال، این دستور تمام خط‌مشی‌ها را در میزبان مجازی پیش‌فرض فهرست می‌کند:
.sp
.Dl rabbitmqctl list_policies
.\" ------------------------------------------------------------------
.It Cm set_operator_policy Oo Fl p Ar vhost Oc Oo Fl -priority Ar priority Oc Oo Fl -apply-to Ar apply-to Oc Ar name Ar pattern Ar definition
.Pp
یک خط‌مشی عملگر (operator policy) تنظیم می‌کند که زیرمجموعه‌ای از آرگومان‌ها را در خط‌مشی‌های کاربر لغو می‌کند.
آرگومان‌ها با آرگومان‌های
.Cm set_policy
یکسان هستند.
.Pp
آرگومان‌های پشتیبانی‌شده عبارتند از:
.Bl -bullet -compact
.It
expires
.It
message-ttl
.It
max-length
.It
max-length-bytes
.El
.\" ------------------------------------------------------------------
.It Cm set_policy Oo Fl p Ar vhost Oc Oo Fl -priority Ar priority Oc Oo Fl -apply-to Ar apply-to Oc Ar name Ar pattern Ar definition
.Pp
یک خط‌مشی را تنظیم می‌کند.
.Bl -tag -width Ds
.It Ar name
نام خط‌مشی.
.It Ar pattern
عبارت باقاعده (regular expression) که در صورت تطابق با نام منبع، اجازه اعمال خط‌مشی را می‌دهد.
.It Ar definition
تعریف خط‌مشی، به صورت یک سند JSON.
در اکثر پوسته‌ها بسیار محتمل است که نیاز به نقل‌قول کردن آن داشته باشید.
.It Ar priority
اولویت خط‌مشی به صورت یک عدد صحیح.
اعداد بزرگ‌تر اولویت بیشتری را نشان می‌دهند.
مقدار پیش‌فرض 0 است.
.It Ar apply-to
انواعی از اشیاء که این خط‌مشی باید روی آن‌ها اعمال شود.
مقادیر ممکن عبارتند از:
.Bl -bullet -compact
.It
queues (همه انواع صف، از جمله streams)
.It
classic_queues (فقط صف‌های classic)
.It
quorum_queues (فقط صف‌های quorum)
.It
streams (فقط streams)
.It
exchanges
.It
all
.El
مقدار پیش‌فرض
.Cm all
است.
.El
.Pp
برای مثال، این دستور خط‌مشی
.Qq federate-me
را در میزبان مجازی پیش‌فرض تنظیم می‌کند تا مبادله‌های توکار به صورت فدراسیونی پیکربندی شوند:
.sp
.Dl rabbitmqctl set_policy federate-me "^amq." '{"federation-upstream-set":"all"}'
.\" ------------------------------------------------------------------
.It Cm clear_policy Oo Fl p Ar vhost Oc Ar name
.Pp
یک خط‌مشی را پاک می‌کند.
.Bl -tag -width Ds
.It Ar name
نام خط‌مشی که پاک می‌شود.
.El
.Pp
برای مثال، این دستور خط‌مشی
.Qq federate-me
را در میزبان مجازی پیش‌فرض پاک می‌کند:
.sp
.Dl rabbitmqctl clear_policy federate-me
.\" ------------------------------------------------------------------
.It Cm clear_operator_policy Oo Fl p Ar vhost Oc Ar name
.Pp
یک خط‌مشی عملگر را پاک می‌کند.
آرگومان‌ها با آرگومان‌های
.Cm clear_policy
یکسان هستند.
.\" ------------------------------------------------------------------
.It Cm list_operator_policies Op Fl p Ar vhost
.Pp
لغوهای خط‌مشی عملگر را برای یک میزبان مجازی فهرست می‌کند.
آرگومان‌ها با آرگومان‌های
.Cm list_policies
یکسان هستند.
.El
.\" ------------------------------------------------------------------
.\" ## Virtual Host Management
.\" ------------------------------------------------------------------
.Ss "میزبان‌های مجازی (Virtual hosts)"
توجه داشته باشید که
.Nm
پایگاه داده داخلی کاربران RabbitMQ را مدیریت می‌کند.
مجوزهای کاربران از هر بک‌اند احراز هویت دیگر برای
.Nm
قابل مشاهده نخواهد بود.
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm add_vhost Ar vhost Op Fl -description Ar desc Fl -tags Ar tags Fl -default-queue-type Ar default-q-type
.Bl -tag -width Ds
.It Ar vhost
نام ورودی میزبان مجازی جهت ایجاد.
.It Ar desc
توضیحات اختیاری میزبان مجازی، مثلاً هدف آن، برای راحتی اپراتور.
.It Ar tags
فهرستی از برچسب‌های میزبان مجازی جداشده با کاما برای راحتی اپراتور.
.It Ar default-q-type
اگر کلاینت‌ها نوع صف را صراحتاً مشخص نکنند، از این نوع استفاده خواهد شد. یکی از: quorum، stream.
.El
.Pp
یک میزبان مجازی ایجاد می‌کند.
.Pp
برای مثال، این دستور به کارگزار RabbitMQ دستور می‌دهد که یک میزبان مجازی جدید به نام
.Qq project9_dev_18
ایجاد کند:
.Pp
.Dl rabbitmqctl add_vhost project9_dev_18 --description 'Dev environment no. 18' --tags "dev,project9"
.\" ------------------------------------------------------------------
.It Cm clear_vhost_limits Op Fl p Ar vhost
.Pp
محدودیت‌های میزبان مجازی را پاک می‌کند.
.Pp
برای مثال، این دستور محدودیت‌های vhost را در میزبان مجازی
.Qq qa_env
پاک می‌کند:
.sp
.Dl rabbitmqctl clear_vhost_limits -p qa_env
.\" ------------------------------------------------------------------
.It Cm delete_vhost Ar vhost
.Bl -tag -width Ds
.It Ar vhost
نام ورودی میزبان مجازی جهت حذف.
.El
.Pp
یک میزبان مجازی را حذف می‌کند.
.Pp
حذف یک میزبان مجازی باعث حذف تمام مبادله‌ها، صف‌ها، اتصالات (bindings)، مجوزهای کاربر، پارامترها و خط‌مشی‌های آن می‌شود.
.Pp
برای مثال، این دستور به کارگزار RabbitMQ دستور می‌دهد تا میزبان مجازی با نام
.Qq test
را حذف کند:
.sp
.Dl rabbitmqctl delete_vhost a-vhost
.\" ------------------------------------------------------------------
.It Cm list_vhost_limits Oo Fl p Ar vhost Oc Oo Fl -global Oc Op Fl -no-table-headers
.Pp
محدودیت‌های پیکربندی‌شده میزبان مجازی را نمایش می‌دهد.
.Bl -tag -width Ds
.It Fl -global
محدودیت‌ها را برای تمام vhostها نمایش می‌دهد.
پارامتر
.Fl p
را نادیده می‌گیرد.
.El
.\" ------------------------------------------------------------------
.It Cm restart_vhost Oo Fl p Ar vhost Oc
.Bl -tag -width Ds
.It Ar vhost
نام ورودی میزبان مجازی برای راه‌اندازی مجدد، با مقدار پیش‌فرض "/".
.El
.Pp
فروشگاه‌های داده و صف‌های شکست‌خورده یک vhost را مجدداً راه‌اندازی می‌کند.
.Pp
برای مثال، این دستور به کارگزار RabbitMQ دستور می‌دهد تا میزبان مجازی به نام
.Qq test
را مجدداً راه‌اندازی کند:
.Pp
.Dl rabbitmqctl restart_vhost test
.\" ------------------------------------------------------------------
.It Cm set_vhost_limits Oo Fl p Ar vhost Oc Ar definition
.Pp
محدودیت‌های میزبان مجازی را تنظیم می‌کند.
.Bl -tag -width Ds
.It Ar definition
تعریف محدودیت‌ها، به صورت یک سند JSON.
در اکثر پوسته‌ها بسیار محتمل است که نیاز به نقل‌قول کردن آن داشته باشید.
.Pp
محدودیت‌های شناخته‌شده عبارتند از:
.Bl -bullet -compact
.It
max-connections
.It
max-queues
.El
.Pp
از یک مقدار منفی برای مشخص کردن «بدون محدودیت» استفاده کنید.
.El
.Pp
برای مثال، این دستور حداکثر تعداد اتصالات هم‌زمان را در vhost با نام
.Qq qa_env
به 64 محدود می‌کند:
.sp
.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": 64}'
.Pp
این دستور حداکثر تعداد صف‌ها را در vhost با نام
.Qq qa_env
به 256 محدود می‌کند:
.sp
.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max-queues": 256}'
.Pp
این دستور محدودیت حداکثر تعداد اتصالات را در vhost با نام
.Qq qa_env
پاک می‌کند:
.sp
.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max\-connections": \-1}'
.Pp
این دستور اتصالات کلاینت را در vhost با نام
.Qq qa_env
غیرفعال می‌کند:
.sp
.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": 0}'
.\" ------------------------------------------------------------------
.It Cm set_user_limits Oc Ar username Oc Ar definition
.Pp
محدودیت‌های کاربر را تنظیم می‌کند.
.Bl -tag -width Ds
.It Ar username
نام کاربری که محدودیت‌ها روی آن اعمال می‌شود
.It Ar definition
تعریف محدودیت‌ها، به صورت یک سند JSON.
در اکثر پوسته‌ها بسیار محتمل است که نیاز به نقل‌قول کردن آن داشته باشید.
.Pp
محدودیت‌های شناخته‌شده عبارتند از:
.Bl -bullet -compact
.It
max-connections
.It
max-channels
.El
.Pp
از یک مقدار منفی برای مشخص کردن «بدون محدودیت» استفاده کنید.
.El
.Pp
برای مثال، این دستور حداکثر تعداد اتصالات هم‌زمانی را که کاربر
.Qq limited_user
مجاز به باز کردن است به 64 محدود می‌کند:
.sp
.Dl rabbitmqctl set_user_limits limited_user '{"max-connections": 64}'
.Pp
این دستور حداکثر تعداد کانال‌هایی را که یک کاربر مجاز است روی یک اتصال باز کند برای کاربر
.Qq limited_user
به 16 محدود می‌کند:
.sp
.Dl rabbitmqctl set_user_limits limited_user '{"max-channels": 16}'
.Pp
این دستور محدودیت حداکثر تعداد اتصالات را برای کاربر
.Qq limited_user
پاک می‌کند:
.sp
.Dl rabbitmqctl set_user_limits limited_user '{"max-connections": 0}'
.\" ------------------------------------------------------------------
.It Cm clear_user_limits Oc Ar username Oc Ar limit
.Pp
محدودیت‌های کاربر را پاک می‌کند.
.Bl -tag -width Ds
.It Ar username
نام کاربری که محدودیت‌های آن پاک می‌شود
.It Ar limit
نام محدودیت یا "all" برای پاک کردن یک‌باره همه محدودیت‌ها.
.El
.Pp
محدودیت‌های شناخته‌شده عبارتند از:
.Bl -bullet -compact
.It
max-connections
.It
max-channels
.El
.Pp
برای مثال، این دستور محدودیت‌های حداکثر اتصال کاربر
.Qq limited_user
را پاک می‌کند:
.sp
.Dl rabbitmqctl clear_user_limits limited_user 'max-connections'
.Pp
این دستور تمام محدودیت‌های کاربر
.Qq limited_user
را پاک می‌کند:
.sp
.Dl rabbitmqctl clear_user_limits limited_user all
.\" ------------------------------------------------------------------
.It Cm trace_off Op Fl p Ar vhost
.Bl -tag -width Ds
.It Ar vhost
نام میزبان مجازی که ردیابی برای آن متوقف می‌شود.
.El
.Pp
ردیابی را متوقف می‌کند.
.\" ------------------------------------------------------------------
.It Cm trace_on Op Fl p Ar vhost
.Bl -tag -width Ds
.It Ar vhost
نام میزبان مجازی که ردیابی برای آن شروع می‌شود.
.El
.Pp
ردیابی را شروع می‌کند.
توجه داشته باشید که وضعیت ردیابی ماندگار نیست؛ در صورت راه‌اندازی مجدد نود به حالت غیرفعال بازمی‌گردد.
.El
.\" ------------------------------------------------------------------
.\" ## Configuration
.\" ------------------------------------------------------------------
.Ss "پیکربندی (Configuration)"
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm decode Ar value Ar passphrase Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
.Bl -tag -width Ds
.It Ar value Ar passphrase
مقدار رمزگشایی (تولیدشده توسط دستور encode) و عبارت عبور.
.Pp
برای مثال:
.sp
.Dl rabbitmqctl decode '{encrypted, <<"...">>}' mypassphrase
.It Fl -cipher Ar cipher Fl -hash Ar hash Fl -iterations Ar iterations
گزینه‌هایی برای مشخص کردن تنظیمات رمزگشایی.
آن‌ها می‌توانند به صورت مستقل استفاده شوند.
.Pp
برای مثال:
.sp
.Dl rabbitmqctl decode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '{encrypted,<<"...">>} mypassphrase
.El
.\" ------------------------------------------------------------------
.It Cm encode Ar value Ar passphrase Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
.Bl -tag -width Ds
.It Ar value Ar passphrase
مقدار برای رمزگذاری و عبارت عبور.
.Pp
برای مثال:
.sp
.Dl rabbitmqctl encode '<<"guest">>' mypassphrase
.It Fl -cipher Ar cipher Fl -hash Ar hash Fl -iterations Ar iterations
گزینه‌هایی برای مشخص کردن تنظیمات رمزگذاری.
آن‌ها می‌توانند به صورت مستقل استفاده شوند.
.Pp
برای مثال:
.sp
.Dl rabbitmqctl encode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '<<"guest">>' mypassphrase
.El
.\" ------------------------------------------------------------------
.It Cm set_cluster_name Ar name
.Pp
نام کلاستر را روی
.Ar name
تنظیم می‌کند.
نام کلاستر در هنگام اتصال به کلاینت‌ها اعلام می‌شود و توسط افزونه‌های federation و shovel برای ثبت اینکه یک پیام در کجا بوده است استفاده می‌شود.
نام کلاستر به طور پیش‌فرض از نام میزبان اولین نود در کلاستر گرفته می‌شود اما قابل تغییر است.
.Pp
برای مثال، این دستور نام کلاستر را روی
.Qq london
تنظیم می‌کند:
.sp
.Dl rabbitmqctl set_cluster_name london
.\" ------------------------------------------------------------------
.It Cm set_disk_free_limit Ar disk_limit
.Bl -tag -width Ds
.It Ar disk_limit
حد آستانه پایین به عنوان یک عدد صحیح بر حسب بایت یا یک رشته با نماد واحد حافظه (نگاه کنید به vm_memory_high_watermark)، به عنوان مثال 512M یا 1G.
به محض اینکه فضای خالی دیسک به این حد برسد، یک هشدار دیسک تنظیم خواهد شد.
.El
.\" ------------------------------------------------------------------
.It Cm set_disk_free_limit mem_relative Ar fraction
.Bl -tag -width Ds
.It Ar fraction
حد نسبت به کل حافظه RAM موجود به عنوان یک عدد اعشاری غیر منفی.
مقادیر کمتر از 1.0 می‌توانند خطرناک باشند و باید با احتیاط استفاده شوند.
.El
.\" ------------------------------------------------------------------
.It Cm set_log_level Op Ar log_level
.Pp
سطح گزارش‌گیری (log level) را در نود در حال اجرا تنظیم می‌کند
.Pp
مقادیر پشتیبانی‌شده
.Ar log_level
عبارتند از:
.Bl -bullet -compact
.It
debug
.It
info
.It
warning
.It
error
.It
critical
.It
none
.El
.Pp
مثال:
.Sp
.Dl rabbitmqctl set_log_level debug
.\" ------------------------------------------------------------------
.It Cm set_vm_memory_high_watermark Ar fraction
.Bl -tag -width Ds
.It Ar fraction
کسر آستانه حافظه جدید که در آن کنترل جریان (flow control) فعال می‌شود، به صورت یک عدد اعشاری بزرگتر یا مساوی 0.
.El
.\" ------------------------------------------------------------------
.It Cm set_vm_memory_high_watermark Oo absolute Oc Ar memory_limit
.Bl -tag -width Ds
.It Ar memory_limit
حد حافظه جدید که در آن کنترل جریان فعال می‌شود، به صورت بایت به عنوان یک عدد صحیح بزرگتر یا مساوی 0 یا به صورت یک رشته با نماد واحد حافظه بیان می‌شود (به عنوان مثال 512M یا 1G).
نمادهای واحد موجود عبارتند از:
.Bl -tag -width Ds
.It Cm k , Cm kiB
کیبی‌بایت (2^10 بایت)
.It Cm M , Cm MiB
مبی‌بایت (2^20 بایت)
.It Cm G , Cm GiB
گیبی‌بایت (2^30 بایت)
.It Cm kB
کیلوبایت (10^3 بایت)
.It Cm MB
مگابایت (10^6 بایت)
.It Cm GB
گیگابایت (10^9 بایت)
.El
.El
.El
.\" ------------------------------------------------------------------
.\" ## Feature Flags
.\" ------------------------------------------------------------------
.Ss "پرچم‌های ویژگی (Feature flags)"
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm enable_feature_flag Ar feature_flag
.Pp
یک پرچم ویژگی را در نود مقصد فعال می‌کند.
.Pp
مثال:
.Sp
.Dl rabbitmqctl enable_feature_flag restart_streams
.Pp
شما همچنین می‌توانید با مشخص کردن "all" تمام پرچم‌های ویژگی را فعال کنید:
.Sp
.Dl rabbitmqctl enable_feature_flag "all"
.\" ------------------------------------------------------------------
.It Cm list_feature_flags Op Ar column ...
.Pp
پرچم‌های ویژگی را فهرست می‌کند
.Pp
مقادیر پشتیبانی‌شده
.Ar column
عبارتند از:
.Bl -bullet -compact
.It
name
.It
state
.It
stability
.It
provided_by
.It
desc
.It
doc_url
.El
.Pp
مثال:
.Sp
.Dl rabbitmqctl list_feature_flags name state
.El
.\" ------------------------------------------------------------------
.\" ## Misc Operations
.\" ------------------------------------------------------------------
.Ss "عملیات اتصال (Connection Operations)"
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm close_all_connections Oo Fl p Ar vhost Oc Oo Fl -global Oc Oo Fl -per-connection-delay Ar delay Oc Oo Fl -limit Ar limit Oc Ar explanation
.Bl -tag -width Ds
.It Fl p Ar vhost
نام میزبان مجازی که اتصالات آن باید بسته شود.
هنگامی که
.Fl -global
مشخص شده باشد نادیده گرفته می‌شود.
.It Fl -global
آیا اتصالات باید برای تمام vhostها بسته شوند.
روی
.Fl p
اولویت دارد.
.It Fl -per-connection-delay Ar delay
مدت زمان بر حسب میلی‌ثانیه برای انتظار پس از بسته شدن هر اتصال.
.It Fl -limit Ar limit
تعداد اتصالاتی که باید بسته شوند.
فقط به ازای هر vhost کار می‌کند.
هنگامی که
.Fl -global
مشخص شده باشد نادیده گرفته می‌شود.
.It Ar explanation
رشته توضیحات.
.El
.Pp
به کارگزار دستور می‌دهد که تمام اتصالات را برای vhost مشخص‌شده یا کل نود RabbitMQ ببندد.
.Pp
برای مثال، این دستور به کارگزار RabbitMQ دستور می‌دهد تا 10 اتصال را در vhost با نام
.Qq qa_env
با ارسال توضیح
.Qq Please close
ببندد:
.sp
.Dl rabbitmqctl close_all_connections -p qa_env --limit 10 'Please close'
.Pp
این دستور به کارگزار دستور می‌دهد تا تمام اتصالات به نود را ببندد:
.sp
.Dl rabbitmqctl close_all_connections --global
.sp
.\" ------------------------------------------------------------------
.It Cm close_connection Ar connectionpid Ar explanation
.Bl -tag -width Ds
.It Ar connectionpid
شناسه فرآیند Erlang مرتبط با اتصالی که باید بسته شود.
.It Ar explanation
رشته توضیحات.
.El
.Pp
به کارگزار دستور می‌دهد که اتصال مرتبط با شناسه فرآیند Erlang
.Ar connectionpid
(همچنین به دستور
.Cm list_connections
مراجعه کنید) را ببندد و رشته
.Ar explanation
را به عنوان بخشی از پروتکل قطع اتصال AMQP به کلاینت متصل ارسال کند.
.Pp
برای مثال، این دستور به کارگزار RabbitMQ دستور می‌دهد تا اتصال مرتبط با شناسه فرآیند Erlang
.Qq <rabbit@tanto.4262.0>
را با ارسال توضیح
.Qq go away
به کلاینت متصل ببندد:
.sp
.Dl rabbitmqctl close_connection Qo <rabbit@tanto.4262.0> Qc Qq go away
.El
.\" ------------------------------------------------------------------
.\" ## Misc
.\" ------------------------------------------------------------------
.Ss "متفرقه (Misc)"
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm eval Ar expression
.Pp
یک عبارت Erlang را در نود مقصد ارزیابی می‌کند
.El
.\" ------------------------------------------------------------------
.\" ## Queue Operations
.\" ------------------------------------------------------------------
.Ss "عملیات صف (Queue Operations)"
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm delete_queue Ar queue_name Oo Fl -if-empty | Fl e Oc Op Fl -if-unused | Fl u
.Bl -tag -width Ds
.It Ar queue_name
نام صف جهت حذف.
.It Ar --if-empty
صف را در صورتی حذف کند که خالی باشد (هیچ پیامی آماده تحویل نداشته باشد)
.It Ar --if-unused
صف را فقط در صورتی حذف کند که مصرف‌کننده‌ای نداشته باشد
.El
.Pp
یک صف را حذف می‌کند.
.\" ------------------------------------------------------------------
.It Cm purge_queue Oo Fl p Ar vhost Oc Ar queue
.Bl -tag -width Ds
.It Ar queue
نام صف جهت پاکسازی.
.El
.Pp
یک صف را پاکسازی می‌کند (تمام پیام‌های موجود در آن را حذف می‌کند).
.El
.\" ------------------------------------------------------------------------------------------------
.Sh "دستورهای افزونه (PLUGIN COMMANDS)"
.\" ------------------------------------------------------------------------------------------------
افزونه‌های RabbitMQ در صورت فعال بودن می‌توانند ابزار rabbitmqctl را برای افزودن دستورات جدید گسترش دهند.
دستورات در دسترس فعلی را می‌توان در خروجی
.Cm rabbitmqctl help
یافت.
دستورات زیر توسط افزونه‌های RabbitMQ که در توزیع پیش‌فرض در دسترس هستند اضافه می‌شوند:
.\" ------------------------------------------------------------------
.\" ## Shovel
.\" ------------------------------------------------------------------
.Ss "افزونه Shovel (Shovel plugin)"
.Bl -tag -width Ds
.It Cm shovel_status
فهرستی از Shovelهای پیکربندی‌شده را چاپ می‌کند
.It Cm delete_shovel Oo Fl p Ar vhost Oc Ar name
به نود RabbitMQ دستور می‌دهد تا shovel پیکربندی‌شده را بر اساس
.Ar name
حذف کند.
.El
.\" ------------------------------------------------------------------
.\" ## Federation
.\" ------------------------------------------------------------------
.Ss "افزونه Federation (Federation plugin)"
.Bl -tag -width Ds
.It Cm federation_status Op Fl -only-down
فهرستی از پیوندهای federation را چاپ می‌کند.
.Bl -tag -width Ds
.It Fl -only-down
تنها پیوندهای federation که در حال اجرا نیستند را فهرست می‌کند.
.El
.It Cm restart_federation_link Ar link_id
به نود RabbitMQ دستور می‌دهد تا پیوند federation با
.Ar link_id
مشخص‌شده را مجدداً راه‌اندازی کند.
.El
.\" ------------------------------------------------------------------
.\" ## AMQP 1.0
.\" ------------------------------------------------------------------
.Ss "افزونه AMQP 1.0 (AMQP 1.0 plugin)"
.Bl -tag -width Ds
.It Cm list_amqp10_connections Op Ar amqp10_connectioninfoitem ...
مشابه دستور
.Cm list_connections
است، اما فیلدهایی را برمی‌گرداند که برای اتصالات AMQP-1.0 معنادار هستند.
پارامتر
.Ar amqp10_connectioninfoitem
برای نشان دادن این موضوع استفاده می‌شود که کدام موارد اطلاعات اتصال در نتایج گنجانده شوند.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar amqp10_connectioninfoitem
می‌تواند هر مقداری را از فهرستی که در ادامه می‌آید داشته باشد:
.Bl -tag -width Ds
.It Cm pid
شناسه فرآیند Erlang مرتبط با اتصال.
.It Cm auth_mechanism
مکانیسم احراز هویت SASL استفاده‌شده، مانند
.Qq PLAIN .
.It Cm host
نام میزبان سرور دریافت‌شده از طریق DNS معکوس، یا آدرس IP آن در صورتی که DNS معکوس با شکست مواجه شده یا خاموش باشد.
.It Cm frame_max
حداکثر اندازه فریم (بایت).
.It Cm timeout
مهلت زمانی اتصال / بازه زمانی ضربان قلب (heartbeat) توافق‌شده، بر حسب ثانیه.
.It Cm user
نام کاربری مرتبط با اتصال.
.It Cm state
وضعیت اتصال؛ یکی از موارد زیر:
.Bl -bullet -compact
.It
starting
.It
waiting_amqp0100
.It
securing
.It
running
.It
blocking
.It
blocked
.It
closing
.It
closed
.El
.It Cm recv_oct
اکتت‌های دریافت‌شده.
.It Cm recv_cnt
بسته‌های دریافت‌شده.
.It Cm send_oct
اکتت‌های ارسال‌شده.
.It Cm send_cnt
بسته‌های ارسال‌شده.
.It Cm ssl
یک مقدار بولی که نشان می‌دهد آیا اتصال با SSL امن شده است یا خیر.
.It Cm ssl_protocol
پروتکل SSL (به عنوان مثال\&
.Qq tlsv1 ) .
.It Cm ssl_key_exchange
الگوریتم تبادل کلید SSL (به عنوان مثال\&
.Qq rsa ) .
.It Cm ssl_cipher
الگوریتم رمزنگاری SSL (به عنوان مثال\&
.Qq aes_256_cbc ) .
.It Cm ssl_hash
تابع درهم‌ساز SSL (به عنوان مثال\&
.Qq sha ) .
.It Cm peer_cert_subject
موضوع گواهی SSL طرف مقابل، در قالب RFC4514.
.It Cm peer_cert_issuer
صادرکننده گواهی SSL طرف مقابل، در قالب RFC4514.
.It Cm peer_cert_serial_number
شماره سریال گواهی SSL طرف مقابل، به صورت هگزادسیمال.
.It Cm peer_cert_validity
دوره‌ای که گواهی SSL طرف مقابل در آن معتبر است.
.It Cm node
نام نود RabbitMQ که اتصال به آن برقرار شده است.
.El
.El
.\" ------------------------------------------------------------------
.\" ## MQTT
.\" ------------------------------------------------------------------
.Ss "افزونه MQTT (MQTT plugin)"
.Bl -tag -width Ds
.It Cm list_mqtt_connections Op Ar mqtt_connectioninfoitem
مشابه دستور
.Cm list_connections
است، اما فیلدهایی را برمی‌گرداند که برای اتصالات MQTT معنادار هستند.
پارامتر
.Ar mqtt_connectioninfoitem
برای نشان دادن این موضوع استفاده می‌شود که کدام موارد اطلاعات اتصال در نتایج گنجانده شوند.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar mqtt_connectioninfoitem
می‌تواند هر مقداری را از فهرستی که در ادامه می‌آید داشته باشد:
.Bl -tag -width Ds
.It Cm host
نام میزبان سرور دریافت‌شده از طریق DNS معکوس، یا آدرس IP آن در صورتی که DNS معکوس با شکست مواجه شده یا خاموش باشد.
.It Cm port
پورت سرور.
.It Cm peer_host
نام میزبان طرف مقابل دریافت‌شده از طریق DNS معکوس، یا آدرس IP آن در صورتی که DNS معکوس با شکست مواجه شده یا فعال نباشد.
.It Cm peer_port
پورت طرف مقابل.
.It Cm protocol
نسخه پروتکل MQTT، که می‌تواند یکی از موارد زیر باشد:
.Bl -bullet -compact
.It
{'MQTT', N/A}
.It
{'MQTT', 3.1.0}
.It
{'MQTT', 3.1.1}
.El
.It Cm channels
تعداد کانال‌هایی که از این اتصال استفاده می‌کنند.
.It Cm channel_max
حداکثر تعداد کانال‌ها روی این اتصال.
.It Cm frame_max
حداکثر اندازه فریم (بایت).
.It Cm client_properties
ویژگی‌های اطلاعاتی ارسال‌شده توسط کلاینت در طول برقراری اتصال.
.It Cm ssl
یک مقدار بولی که نشان می‌دهد آیا اتصال با SSL امن شده است یا خیر.
.It Cm ssl_protocol
پروتکل SSL (به عنوان مثال\&
.Qq tlsv1 ) .
.It Cm ssl_key_exchange
الگوریتم تبادل کلید SSL (به عنوان مثال\&
.Qq rsa ) .
.It Cm ssl_cipher
الگوریتم رمزنگاری SSL (به عنوان مثال\&
.Qq aes_256_cbc ) .
.It Cm ssl_hash
تابع درهم‌ساز SSL (به عنوان مثال\&
.Qq sha ) .
.It Cm conn_name
نام خوانا برای اتصال.
.It Cm connection_state
وضعیت اتصال؛ یکی از موارد زیر:
.Bl -bullet -compact
.It
starting
.It
running
.It
blocked
.El
.It Cm connection
شناسه فرآیند Erlang مرتبط با اتصال مستقیم داخلی amqp.
.It Cm consumer_tags
یک تاپل از برچسب‌های مصرف‌کننده برای QOS0 و QOS1.
.It Cm message_id
آخرین شناسه بسته (Packet ID) ارسال‌شده در یک پیام کنترلی.
.It Cm client_id
شناسه کلاینت MQTT برای اتصال.
.It Cm clean_sess
پرچم نشست پاک (clean session) پروتکل MQTT.
.It Cm will_msg
پیام وصیت (Will message) پروتکل MQTT ارسال‌شده در فریم CONNECT.
.It Cm exchange
مبادله برای هدایت پیام‌های MQTT پیکربندی‌شده در محیط برنامه rabbitmq_mqtt.
.It Cm ssl_login_name
نام احراز هویت گواهی طرف مقابل SSL
.It Cm retainer_pid
شناسه فرآیند Erlang مرتبط با فضای ذخیره‌سازی نگه‌داری (retain) برای اتصال.
.It Cm user
نام کاربری مرتبط با اتصال.
.It Cm vhost
نام میزبان مجازی که کاراکترهای غیر ASCII آن مانند زبان C گریز داده شده‌اند (escaped).
.El
.It Cm decommission_mqtt_node
پیش از غیرفعال شدن این افزونه روی یک نود، یا حذف شدن یک نود از کلاستر،
باید از رده خارج (decommission) شود.
.Pp
برای مثال، این دستور نود rabbit@stringer را حذف خواهد کرد:
.sp
.Dl rabbitmqctl decommission_mqtt_node rabbit@stringer
.El
.\" ------------------------------------------------------------------
.\" ## STOMP
.\" ------------------------------------------------------------------
.Ss "افزونه STOMP (STOMP plugin)"
.Bl -tag -width Ds
.It Cm list_stomp_connections Op Ar stomp_connectioninfoitem
مشابه دستور
.Cm list_connections
است، اما فیلدهایی را برمی‌گرداند که برای اتصالات STOMP معنادار هستند.
پارامتر
.Ar stomp_connectioninfoitem
برای نشان دادن این موضوع استفاده می‌شود که کدام موارد اطلاعات اتصال در نتایج گنجانده شوند.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar stomp_connectioninfoitem
می‌تواند هر مقداری را از فهرستی که در ادامه می‌آید داشته باشد:
.Bl -tag -width Ds
.It Cm conn_name
نام خوانا برای اتصال.
.It Cm connection
شناسه فرآیند Erlang مرتبط با اتصال مستقیم داخلی amqp.
.It Cm connection_state
وضعیت اتصال؛ یکی از موارد زیر:
.Bl -bullet -compact
.It
running
.It
blocking
.It
blocked
.El
.It Cm session_id
شناسه نشست پروتکل STOMP
.It Cm channel
کانال AMQP مرتبط با اتصال
.It Cm version
نسخه پروتکل STOMP توافق‌شده برای اتصال.
.It Cm implicit_connect
نشان می‌دهد که آیا اتصال با استفاده از اتصال ضمنی (بدون فریم CONNECT) برقرار شده است یا خیر
.It Cm auth_login
نام کاربری مؤثر برای اتصال.
.It Cm auth_mechanism
مکانیسم مجوزدهی STOMP.
می‌تواند یکی از موارد زیر باشد:
.Bl -bullet -compact
.It
config
.It
ssl
.It
stomp_headers
.El
.It Cm port
پورت سرور.
.It Cm host
نام میزبان سرور دریافت‌شده از طریق DNS معکوس، یا آدرس IP آن در صورتی که DNS معکوس با شکست مواجه شده یا فعال نباشد.
.It Cm peer_port
پورت طرف مقابل.
.It Cm peer_host
نام میزبان طرف مقابل دریافت‌شده از طریق DNS معکوس، یا آدرس IP آن در صورتی که DNS معکوس با شکست مواجه شده یا فعال نباشد.
.It Cm protocol
نسخه پروتکل STOMP، که می‌تواند یکی از موارد زیر باشد:
.Bl -bullet -compact
.It
{'STOMP', 0}
.It
{'STOMP', 1}
.It
{'STOMP', 2}
.El
.It Cm channels
تعداد کانال‌هایی که از این اتصال استفاده می‌کنند.
.It Cm channel_max
حداکثر تعداد کانال‌ها روی این اتصال.
.It Cm frame_max
حداکثر اندازه فریم (بایت).
.It Cm client_properties
ویژگی‌های اطلاعاتی ارسال‌شده توسط کلاینت در طول برقراری اتصال
.It Cm ssl
یک مقدار بولی که نشان می‌دهد آیا اتصال با SSL امن شده است یا خیر.
.It Cm ssl_protocol
پروتکل TLS (به عنوان مثال\&
.Qq tlsv1 ) .
.It Cm ssl_key_exchange
الگوریتم تبادل کلید TLS (به عنوان مثال\&
.Qq rsa ) .
.It Cm ssl_cipher
الگوریتم رمزنگاری TLS (به عنوان مثال\&
.Qq aes_256_cbc ) .
.It Cm ssl_hash
تابع درهم‌ساز SSL (به عنوان مثال\&
.Qq sha ) .
.El
.El
.\" ------------------------------------------------------------------
.\" ## Management Agent
.\" ------------------------------------------------------------------
.Ss "افزونه Management agent (Management agent plugin)"
.Bl -tag -width Ds
.It Cm reset_stats_db Op Fl -all
پایگاه داده آمار مدیریت را برای نود RabbitMQ بازنشانی می‌کند.
.Bl -tag -width Ds
.It Fl -all
پایگاه داده آمار را برای تمام نودهای موجود در کلاستر بازنشانی می‌کند.
.El
.El
.\" ------------------------------------------------------------------------------------------------
.Sh "همچنین ببینید (SEE ALSO)"
.\" ------------------------------------------------------------------------------------------------
.Xr rabbitmq-diagnostics 8 ,
.Xr rabbitmq-plugins 8 ,
.Xr rabbitmq-server 8 ,
.Xr rabbitmq-queues 8 ,
.Xr rabbitmq-streams 8 ,
.Xr rabbitmq-upgrade 8 ,
.Xr rabbitmq-service 8 ,
.Xr rabbitmq-env.conf 5
.\" ------------------------------------------------------------------------------------------------
.Sh "نویسنده (AUTHOR)"
.\" ------------------------------------------------------------------------------------------------
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com