DOVEADM-DIRECTOR(1) Dovecot DOVEADM-DIRECTOR(1)

doveadm-director - مدیریت دایرکتورهای Dovecot

doveadm [-Dv] [-f formatter] director command [OPTIONS] [ARGUMENTS]

دستور doveadm director می‌تواند برای مدیریت و استعلام وضعیت فهرست سرورهای ایمیل backend که پروکسی Dovecot اتصالات را به آن‌ها هدایت می‌کند، استفاده شود.

گزینه‌های عمومی doveadm(1):

پیام‌های اشکال‌زدایی (debug) و پرگویی را فعال می‌کند.
قالب‌بند (formatter) را برای قالب‌بندی خروجی مشخص می‌کند. قالب‌بندهای پشتیبانی‌شده عبارتند از:
هر سطر را با جفت‌های key=value چاپ می‌کند.
هر جفت key: value را در یک سطر جداگانه چاپ کرده و رکوردها را با نویسهٔ فرم‌فید (^L) از هم جدا می‌کند.
یک سربرگ جدول و به دنبال آن سطرهای حاوی مقادیر جداشده با تب (tab) را چاپ می‌کند.
یک سربرگ جدول و به دنبال آن سطرهایی با مقادیر تراز‌شده چاپ می‌کند.
تنظیم پیکربندی setting را از /etc/dovecot/dovecot.conf و از userdb با مقدار داده‌شدهٔ value بازنویسی می‌کند. جهت بازنویسی چندین تنظیم، می‌توان گزینهٔ -o را چندین بار مشخص کرد.
پرگویی، شامل شمارندهٔ پیشرفت را فعال می‌کند.

گزینه‌های ویژهٔ این دستور:

این گزینه برای مشخص کردن یک سوکت جایگزین استفاده می‌شود. آرگومان این گزینه یا یک مسیر مطلق به یک سوکت محلی دامنه یونیکس است، یا یک نام میزبان و درگاه (hostname:port)، جهت اتصال به یک میزبان دوردست از طریق سوکت TCP.

به‌طور پیش‌فرض doveadm(1) از سوکت /run/dovecot/director-admin استفاده می‌کند. چنانچه تنظیم پیش‌فرض base_dir در /etc/dovecot/dovecot.conf بازنویسی شده باشد، ممکن است سوکت در پوشهٔ دیگری قرار داشته باشد.

نام میزبان یا نشانی IP یک سرور ایمیل.
نشانی IP یک دایرکتور (director).
درگاه TCP که سرور دایرکتور برای اتصالات روی آن شنود می‌کند. درگاه پیش‌فرض همان درگاهی است که دایرکتور محلی روی آن شنود می‌کند.
نام ورود کاربر (user). بسته به پیکربندی، نام ورود می‌تواند به عنوان مثال jane یا john@example.com باشد.
تعداد «میزبان‌های مجازی» (virtual hosts) اختصاص‌یافته به این سرور. هرچه این عدد نسبت به سایر سرورها بیشتر باشد، اتصالات بیشتری دریافت می‌کند. مقدار پیش‌فرض ۱۰۰ است.

doveadm director add [-a director_socket_path] host [vhost_count]

وظایف این دستور عبارتند از:

*
اختصاص دادن یک سرور ایمیل جدید به دایرکتور.
*
افزایش یا کاهش vhost_count یک سرور که پیش‌تر اختصاص داده شده است.

doveadm director dump [-a director_socket_path]

پیکربندی فعلی میزبان را به صورت دستورات doveadm تخلیه (dump) می‌کند. پس از راه‌اندازی مجدد کامل خوشهٔ دایرکتور، می‌توان این دستورات را به سادگی اجرا کرد تا به وضعیت ذخیره‌شده بازگشت.

doveadm director flush [-a director_socket_path] [-F] [--x-parallel n] host|all

دستور doveadm director flush تمام انتساب‌های کاربر را از میزبان (host) داده‌شده یا از همهٔ میزبان‌ها (all) حذف می‌کند. تمام اتصالات موجود بیرون انداخته (kick) خواهند شد. اگر director_flush_socket مشخص شده باشد، یک اسکریپت پاکسازی (flush) نیز به‌طور خودکار اجرا می‌شود.

از آنجا که اخراج و انتقال کاربران به سرورهای پشتیبان جدید باعث افزایش ناگهانی بار (load spike) موقت می‌شود، همه کاربران به یک‌باره منتقل نمی‌شوند. پارامتر --x-parallel مشخص می‌کند که چه تعداد کاربر می‌توانند به‌طور همزمان منتقل شوند. مقدار پیش‌فرض ۱۰۰ است.

اگر از پارامتر -F استفاده شود، انتساب‌های کاربران صرفاً رها (drop) می‌شوند. اتصالات موجود بیرون انداخته نخواهند شد و اسکریپت‌های پاکسازی نیز اجرا نمی‌شوند.

doveadm director kick [-a director_socket_path] user

کاربر (user) مشخص‌شده را از کل خوشهٔ Dovecot بیرون می‌اندازد (kick). این دستور مشابه doveadm proxy kick است، اما این دستور فقط یک بار باید اجرا شود به‌جای اینکه روی تک‌تک سرورهای دایرکتور اجرا گردد.

doveadm director map [-a director_socket_path] [-f users_file] [-h|-u] [host]

دستور doveadm director map برای فهرست کردن نگاشت‌های فعلیِ user → host استفاده می‌شود. توجه داشته باشید که دایرکتور با استفاده از هش‌های ۳۲ بیتی کار می‌کند که احتمال برخورد (collision) در آن‌ها زیاد است، بنابراین این دستور نمی‌تواند به طور دقیق و قابل اطمینان فهرست کند که چه کاربرانی به تازگی وارد سیستم شده‌اند.

مسیر فایلی شامل تمام نام‌های کاربری (یک نام در هر سطر). در صورت ارائه، هیچ جستجویی در userdb انجام نخواهد شد. این گزینه می‌تواند یک راهکار مفید جایگزین باشد هنگامی که به عنوان مثال اتصال شبکه به سرور LDAP یا SQL کند است.
تمام نام‌های کاربری منطبق با هش داده‌شده را خروجی می‌دهد.
هش مربوط به نام کاربری داده‌شده را خروجی می‌دهد.
نشانی IP یا نام میزبان یک سرور را مشخص می‌کند تا فقط نگاشت‌های مربوط به host داده‌شده فهرست شوند.

doveadm director move [-a director_socket_path] user host

کاربر (user) را به سرور پشتیبانِ (host) مشخص‌شده منتقل می‌کند. اگر user هرگونه اتصال فعالی داشته باشد، آن اتصالات خاتمه داده می‌شوند (kill).

doveadm director remove [-a director_socket_path] host

از این دستور برای حذف host داده‌شده از دایرکتور استفاده کنید.

doveadm director ring add [-a director_socket_path] ip [port]

یک دایرکتور جدید را به حلقه (ring) اضافه می‌کند.

doveadm director ring remove [-a director_socket_path] ip [port]

یک دایرکتور را از حلقه حذف می‌کند.

doveadm director ring status [-a director_socket_path]

وضعیت تمام دایرکتورهای موجود در حلقه را نشان می‌دهد.

doveadm director status [-a director_socket_path] [user]

این دستور برای نمایش میزان استفادهٔ فعلی تمام سرورهای ایمیل اختصاص‌یافته استفاده می‌شود.
هنگامی که یک نام کاربری ارائه شود، این دستور نشان می‌دهد که user در حال حاضر به کدام سرور اختصاص یافته است، پس از حذف انتساب ذخیره‌شدهٔ فعلی به کدام سرور اختصاص خواهد یافت، و اگر کل خوشهٔ پروکسی از ابتدا راه‌اندازی مجدد می‌شد، کاربر به کدام سرور اختصاص می‌یافت.

/etc/dovecot/dovecot.conf
فایل پیکربندی اصلی Dovecot.
/etc/dovecot/conf.d/10-director.conf
تنظیمات ویژهٔ دایرکتور (Director).

افزودن یک دایرکتور با تعداد vhost برابر با ۱۵۰ (یا تغییر vhost موجود به ۱۵۰):

doveadm -v director add x1357.imap.ha.example.net 150
2001:db8:543:6861:143::1357: OK

حذف یک دایرکتور:

doveadm director remove x1357.imap.ha.example.net

استعلام وضعیت میزبان‌های ایمیل در یک دایرکتور:

doveadm director status
mail server ip       vhosts  users
192.168.10.1            100    125
192.168.10.2            100    144
192.168.10.3            100    115

استعلام وضعیت انتساب یک کاربر:

doveadm director status user@example.com
Current: 192.168.10.1 (expires 2010-06-18 20:17:04)
Hashed: 192.168.10.2
Initial config: 192.168.10.3

این به این معناست که کاربر در حال حاضر به سرور ایمیل با نشانی IP برابر با 192.168.10.1 اختصاص یافته است. پس از خروج تمام اتصالات کاربر، این انتساب حذف خواهد شد (در حال حاضر به نظر می‌رسد در زمان 20:17:04، اما ممکن است افزایش یابد). پس از منقضی شدن انتساب، کاربر دفعه بعد به 192.168.10.2 هدایت خواهد شد (به فرض عدم تغییر تنظیمات دایرکتور). اگر کل خوشه پروکسی Dovecot مجدداً راه‌اندازی شود، به طوری که تمام پیکربندی دایرکتور به مقادیر اولیه بازگردد، کاربر به 192.168.10.3 هدایت خواهد شد.

گزارش باگ‌ها، شامل خروجی doveconf -n را به فهرست پستی Dovecot به نشانی <dovecot@dovecot.org> ارسال کنید. اطلاعات درباره نحوه گزارش باگ‌ها در این نشانی در دسترس است: http://dovecot.org/bugreport.html

doveadm(1)

2014-08-30 Dovecot v2.3