نام (NAME)

kresctl - ابزار کنترل Knot Resolver 6.4.0، تحلیل‌گر کامل DNS با حافظه پنهان و مجهز به DNSSEC

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

kresctl [-s|--socket API_SOCKET] <command> <args>

توضیحات (DESCRIPTION)

دستور kresctl ابزاری کنترلی برای Knot Resolver است؛ یک تحلیل‌گر کامل DNS با حافظه پنهان و مجهز به DNSSEC.

از kresctl می‌توان برای کنترل و بازرسی پیکربندی Knot Resolver در حال اجرا از طریق رابط برنامه‌نویسی کاربردی HTTP (HTTP API) آن استفاده کرد.

مستندات کامل در https://www.knot-resolver.cz/documentation/latest/ یا در مستندات بسته (که در بیشتر توزیع‌ها به عنوان بسته knot-resolver-doc در دسترس است) موجود است.

گزینه‌ها (OPTIONS)

گزینه‌های موجود عبارتند از:

-s <api_socket>, --socket <api_socket>

نحوه اتصال به یک Knot Resolver در حال اجرا را مشخص می‌کند. یک مسیر به سوکت دامنه یونیکس (Unix-domain socket) یا host:port را می‌پذیرد. مقدار پیش‌فرض /var/run/knot-resolver/kres-api.sock است.

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

-h, --help

چاپ پیام راهنما و خروج.

دستورها (COMMANDS)

config [-d|--delete] [--stdin] json_ptr [new_value]

دریافت یا تغییر پیکربندی زمان اجرای تحلیل‌گر (resolver).

آرگومان json_ptr از استاندارد RFC 6901 پیروی می‌کند و مشخص می‌نماید که این ابزار روی کدام بخش از پیکربندی عمل خواهد کرد. این آرگومان الزامی است. در صورتی که هیچ گزینه یا آرگومان اضافی ارائه نشود، مقدار پیکربندی‌شده فعلی را چاپ می‌کند. معادل متد GET در HTTP API زیرین است.

هنگامی که -d یا --delete ارائه شود، kresctl تلاش می‌کند زیردرخت پیکربندی زمان اجرا را حذف کند. در صورتی که این عملیات پیکربندی را نامعتبر سازد، با شکست مواجه می‌شود. معادل متد DELETE در HTTP API است.

هنگامی که --stdin یا new_value ارائه شوند، مقدار جدید (از طریق آرگومان یا با خواندن از ورودی استاندارد stdin) در مسیر مشخص‌شده توسط json_ptr در پیکربندی قرار می‌گیرد. در صورتی که این عملیات پیکربندی را نامعتبر سازد، با شکست مواجه خواهد شد. معادل متد PUT در HTTP API زیرین است.

stop

تحلیل‌گر در حال اجرا را به آرامی و به صورت مناسب (gracefully) متوقف می‌کند.

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

kresd(8), https://www.knot-resolver.cz/documentation/latest/

نویسندگان (AUTHORS)

توسعه‌دهندگان kresd در فایل AUTHORS در توزیع نرم‌افزار ذکر شده‌اند.