نام (NAME)

kea-shell - کلاینت متنی برای کنترل فرایندهای سرور

خلاصه دستور (SYNOPSIS)

kea-shell [-h] [-v] [--host] [--port] [--path] [--ca] [--cert] [--key] [--auth-user] [--auth-password] [--auth-password-file] [--timeout] [--service] [command]

توضیحات (DESCRIPTION)

برنامه kea-shell یک کلاینت REST برای سرورهای kea-dhcp4، kea-dhcp6 و kea-dhcp-ddns از مجموعه Kea فراهم می‌کند. پیش‌تر این ابزار برای دیمن عامل کنترل یا Control Agent (CA) در نظر گرفته شده بود که اکنون منسوخ (و حذف) شده است. این ابزار دستورات را به عنوان پارامتر خط فرمان دریافت کرده و با کپسوله‌سازی صحیح JSON به سرور Kea ارسال می‌کند. آرگومان‌های اختیاری را می‌توان از طریق ورودی استاندارد مشخص کرد. درخواست از طریق HTTP ارسال شده و پاسخ دریافت و در خروجی استاندارد نمایش داده می‌شود. احراز هویت پایه‌ای HTTP و پروتکل HTTPS (یعنی انتقال بر بستر TLS) پشتیبانی می‌شوند.

آرگومان‌ها (ARGUMENTS)

آرگومان‌ها به شرح زیر هستند:

-h: راهنمای مربوط به پارامترهای خط فرمان را نمایش می‌دهد.
-v: نسخه Kea را نمایش می‌دهد.
--host: میزبانی را که باید به آن متصل شد مشخص می‌کند. سرور Kea باید روی میزبان مشخص‌شده در حال اجرا باشد. در صورت عدم تعیین، از 127.0.0.1 استفاده می‌شود.
--port: پورت TCP را برای اتصال مشخص می‌کند. سرور باید روی پورت مشخص‌شده در حال شنود باشد. در صورت عدم تعیین، از 8000 استفاده می‌شود.
--path: مسیر موجود در URL را برای اتصال مشخص می‌کند. در صورت عدم تعیین، از یک مسیر خالی استفاده می‌شود. از آنجا که سرورهای Kea روی مسیر خالی شنود می‌کنند، این پارامتر تنها در زمان استفاده از یک پروکسی معکوس (reverse proxy) کاربرد دارد.
--ca: نام فایل یا دایرکتوری مرجع صدور گواهی (Certification Authority) را مشخص می‌کند. در صورت عدم تعیین، از HTTPS استفاده نمی‌شود.
--cert: نام فایل گواهی کلید عمومی موجودیت نهایی کاربر (user end-entity public key certificate) را مشخص می‌کند. در صورت تعیین، نام فایل کلید کاربر نیز باید مشخص شود.
--key: نام فایل کلید کاربر را مشخص می‌کند. در صورت تعیین، نام فایل گواهی کاربر نیز باید مشخص شود. فایل‌های کلید رمزنگاری‌شده پشتیبانی نمی‌شوند.
--auth-user: شناسه کاربری را برای احراز هویت پایه‌ای HTTP مشخص می‌کند. در صورت عدم تعیین یا تعیین به صورت یک رشته خالی، از احراز هویت استفاده نمی‌شود.
--auth-password: گذرواژه را برای احراز هویت پایه‌ای HTTP مشخص می‌کند. در صورت عدم تعیین اما در صورت مشخص بودن شناسه کاربری، از گذرواژه خالی استفاده می‌شود. در صورت استفاده هم‌زمان با --auth-password-file، نادیده گرفته می‌شود.
--auth-password-file: یک فایل متنی را مشخص می‌کند که خط اول آن حاوی گذرواژه مورد استفاده برای احراز هویت پایه‌ای HTTP است. این پرچم بر پرچم --auth-password اولویت دارد.
--timeout: مهلت زمانی اتصال (timeout) را بر حسب ثانیه مشخص می‌کند. مقدار پیش‌فرض 10 است.
--service: (منسوخ‌شده) سرورهای Kea شامل kea-dhcp4، kea-dhcp6 و kea-dhcp-ddns این آرگومان را نادیده می‌گیرند. این گزینه برای ارتباط با دیمن منسوخ (حذف‌شده) Control Agent در نظر گرفته شده بود. در صورت استفاده در نسخه‌های قبل از 2.7.2 نرم‌افزار Kea: سرویسی را که هدف یک دستور است مشخص می‌کند. در صورت عدم تعیین، خود Control Agent هدف قرار می‌گیرد. ممکن است بیش از یک بار برای مشخص کردن چندین هدف استفاده شود.
command: دستوری که باید به سرور ارسال شود را مشخص می‌کند. در صورت عدم تعیین، از list-commands استفاده می‌شود.

مستندات (DOCUMENTATION)

پروژه Kea همراه با یک «راهنمای مرجع مدیران Kea» جامع ارائه می‌شود که تمامی جنبه‌های اجرای نرم‌افزار Kea شامل کامپایل، نصب، پیکربندی، مثال‌های پیکربندی و موارد متعدد دیگر را پوشش می‌دهد. همچنین Kea دارای «راهنمای پیام‌های Kea» است که تمام پیام‌های محتمل خروجی Kea را همراه با توضیح مختصری برای هر یک فهرست می‌کند. هر دو سند در قالب‌های مختلف (.txt، .html، .pdf) به همراه توزیع Kea در دسترس هستند. مستندات Kea در نشانی https://kea.readthedocs.io در دسترس است.

کد منبع Kea در «راهنمای توسعه‌دهندگان Kea» مستندسازی شده که در نشانی https://reports.kea.isc.org/dev_guide/ در دسترس است.

وب‌سایت پروژه Kea در نشانی https://kea.isc.org در دسترس است.

فهرست‌های پستی و پشتیبانی (MAILING LISTS AND SUPPORT)

دو فهرست پستی عمومی برای پروژه Kea در دسترس است: kea-users (kea-users در lists.isc.org) برای کاربران Kea در نظر گرفته شده، در حالی که kea-dev (kea-dev در lists.isc.org) برای توسعه‌دهندگان Kea، مشارکت‌کنندگان آینده و سایر کاربران پیشرفته در نظر گرفته شده است. هر دو فهرست در نشانی https://lists.isc.org در دسترس هستند. جامعه کاربری پشتیبانی برمبنای بهترین تلاش (best-effort) را در هر دو فهرست پستی ارائه می‌دهد.

مجموعه ISC پشتیبانی تجاری و حرفه‌ای برای سرویس‌های Kea ارائه می‌کند. برای جزئیات به https://www.isc.org/kea/ مراجعه کنید.

تاریخچه (HISTORY)

ابزار kea-shell نخستین بار در مارس ۲۰۱۷ توسط Tomek Mrugalski برنامه‌نویسی شد.

همچنین ببینید (SEE ALSO)

kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-admin(8), keactrl(8), perfdhcp(8), kea-lfc(8), Kea Administrator Reference Manual.

نویسنده (AUTHOR)

Internet Systems Consortium

حق نشر (COPYRIGHT)

2019-2026, Internet Systems Consortium